Documentation overhaul and update to fast converter function generation #49
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update to fast converter functions
A substantial code change was driven by API autodocs. This was to change from dynamically-generated functions like
date2secs
to the same code-generated functions which now live as static functions inconverters.py
. This is accomplished via a new scriptmake_converters.py
.The dynamically generated functions were not visible to the API autodocs and didn't show up.
These are all covered in unit testing.
Output
See: https://cxc.cfa.harvard.edu/mta/ASPECT/tests/cxotime/pr49/
Requires
Interface impacts
None.
Testing
Unit tests
Independent check of unit tests by Jean
Functional tests
Building docs generates no visible warnings and no errors.