Use :nodoc: to limit public API [ci skip] #2988
Merged
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.
Description
Use
:nodoc:
and add a comment that isn't parsed (note the two blank lines after it) to the following classes/modules:The comment is added to clarify the API status, especially if people are unfamiliar with
:nodoc:
.Some classes/modules really shouldn't be part of the public API, as changes to the public API should only be done with major version updates.
A super top secret, double overtime folder exists at https://msp-greg.github.io/puma_test/ which shows how these changes would appear in docs.
Comments? Add more classes/modules?
Your checklist for this pull request
[ci skip]
to the title of the PR.#issue
" to the PR description or my commit messages.