Revise the section on documenting private parameters. #4490
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
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.
Fix #4479.
This is a much more narrowly scoped solution to #4479. It doesn't change any scoping rules and there's nothing normative. But it aims to guide doc generators to hide the private implementation details of APIs.
If that's not a strong enough guarantee for the core libraries to rely on, then it may make sense for those libraries to not use private initializing formals in public APIs.
But for most users, I think this is plenty robust enough, and it avoids adding unnecessary complexity to the language.
If this one looks OK, then I'll close #4486.