Simplify extracting summaries from ERFA function doc comments#256
Merged
Conversation
So far `erfa_generator` has taken the first and sometimes also the second sentence from an ERFA function doc comment and inserted it into the beginning of the docstring of the corresponding Python function. Always extracting only the first sentence simplifies the code without losing any important information because the full contents of the ERFA doc comments are still available in the Notes section of the docstrings. In practice this change modifies only 4 docstrings. but they all share the second sentence and that same sentence is already omitted from the `apio13()` docstring.
eerovaher
force-pushed
the
doc-comment-first-sentence
branch
from
bf7f6fa to
18042a8
Compare
avalentino
approved these changes
May 26, 2026
This file contains hidden or 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
2 participants
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.
On current
mainbrancherfa_generatorextracts the first and sometimes also the second sentence from an ERFA function doc comment and inserts it into the beginning of the docstring of the corresponding Python function as a summary. This PR always extracts only the first sentence. In practice this only changes the docstrings ofatco13(),atio13(),atoc13()atoi13(), which all have the same second sentence, but this can't be a problem because theeraApio13doc comment also contains that sentence and currentmainis already not including it in theapio13()docstring summary. In any case the full contents of the ERFA doc comments are always added to the Notes sections of the docstrings, so nothing is really being hidden from interested users.