Remove GLOBALS in api docs #4343
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
craigtaub
added
area: documentation
craigtaub
force-pushed
the
craigtaub/4317-fix-api-docs-globals
branch
from
fd8c0e7 to
e9e0292
Compare
boneskull
approved these changes
Jul 1, 2020
Member
boneskull
left a comment
boneskull
left a comment
There was a problem hiding this comment.
Looks fine to me. If I had my way, I'd rename all of the @module tags to be equivalent to their filepaths from lib, e.g., @module common becomes @module interfaces/common. I think that's allowed in jsdoc.
I note that lib/browser/progress.js should be moved to lib/browser/reporters/progress.js at some point.
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.
We should not document any globals in the context of programmatic usage, which is the target for the api docs.
The Members and Methods we have listed live are currently mostly wrong and sometimes sending people down the wrong path. By removing them we remove confusion.
I have given an explicit module directive name to fix the Methods, the other half of Members were manual tags.
Alternative design
We could remove the module directive from the "interfaces/common" module, which leaves just the hooks (after/afterEach/before/beforeEach).
But I decided it was better to have either ALL of the available globals given, or none of them.
Screens
On live
On local - section gone
Applicable issues
#4317