Conversation
Adds a note clarifying that agent.options is not part of the public API and should not be relied upon.
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
Ethan-Arrowood
left a comment
Ethan-Arrowood
left a comment
Contributor
There was a problem hiding this comment.
I don't think this is needed. The collaborator guide specifies "All functionality in the official Node.js documentation is part of the public API." By literally documenting something that is meant to be ignored we are contradicting that rule.
So a couple other options:
- If this API is meant to be public; lets document it!
- If this API is mean to be private, but is publicly accessible, can we consider switching it to a private field? In Node.js we use symbols to achieve this; there is a plethora of example throughout the source to refer to.
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
3 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.
Adds a note clarifying that agent.options is not part of the public API and should not be relied upon.