Documentation: fix up all file docblocks #900
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
This changes all file docblocks to align with the proposal made in issue 734. Any pertinent information which was in the file docblock and wasn't already mentioned elsewhere has been moved to the class docblock.
jrfnl
added
Type: chores/QA
PR: quick merge
wimg
approved these changes
Sep 5, 2019
jrfnl
removed
PR: ready for review
PR: quick merge
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 changes all file docblocks to align with the proposal made in issue #734.
Any pertinent information which was in the file docblock and wasn't already mentioned elsewhere has been moved to the class docblock.
This is the first PR in a series to update the docs to align with the proposal in #734.