Refactor change-set information #105
Merged
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
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
The changeset information is now included in the argument description, not after. Also, minor improvement of the display when mentioning class, method, or function names.
WeisLeDocto
added
the
documentation
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.
Since release
2.0.2(specifically commit 6ec2eb2), change-set information was added to the documentation in order to make it clear at which point in the project's history the changes in the API occurred. However, the change-set information was included in the documentation after the description of the arguments.In this PR, the change-set information is moved inside the argument description, effectively tying it up with the described arguments. Users are less likely to miss this information, and developers are more likely to remember to update it when needed.
Only the information about deleted arguments was kept after the argument description.