feat: Add per-function HISTORY sections #3606
Merged
Conversation
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
Owner
|
Very neat, thanks Glen! |
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.
This PR implements a facility for including HISTORY sections in the block of documentation comments for each function, and retroactively adds such sections to a little over a dozen functions, including all in the
typescategory and scattered other examples.The idea is that going forward, any function that is touched should have its HISTORY section added or updated if it is already there. It will be beneficial to get this merged before v16, so that the PRs there, which touch many functions, will greatly expand the coverage of these HISTORY sections.
Adds a test that all functions have a HISTORY section except those on a list of known exceptions, which should be whittled down whenever HISTORY is added to a function. This facility will ensure all new functions start with a HISTORY section which should consist of one line, indicating the version number in which the function is being added.
Resolves #3341.