Change API documentation headers to be more unique #13113
Merged
Conversation
This file contains 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
hasezoey
added
the
docs
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.
Summary
This PR changes the API documentation headers to be more unique and now have the style of how they would appear in js itself, also includes a script to translate the old header id's to the new ones.
Notes:
because the old id's did not differentiate between static and instance properties and also not between properties and functions, there are multiple tests to see if one exists in the new style, where the first found is used, current order is:
closes #12901
Examples:
mongoose_Mongoose->Mongoose()mongoose_Mongoose-model->Mongoose.prototype.model()model_Model-find->Model.find()