Make titles of the docstrings more useful (plus cleanup) #47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The discussion in liberfa/erfa#24 made me realize that the current docstrings for the python functions are less than helpful, having as title just "Wrapper for ...", which tells one very little. So, I changed the generator such that it uses the first sentence of the description instead. The summary in particular is more descriptive (see below).
As I was a bit irritated in seeing red wiggles while editing various files, I also made everything PEP8 compliant (with slightly longer lines). Finally, in the C code a few mentions of astropy were still present, so I took the opportunity to change those. Those may make review a bit more messy; it may make most sense to look by commit...