[Docs] Refactor header naming to lessen conflicts #12901
Labels
discussion
If you have any thoughts or comments on this issue, please share them!
docs
This issue is due to a mistake or omission in the mongoosejs.com documentation
Milestone
Prerequisites
Issue
Currently in the documentation, a naming of
#type_Type-function
is used, which can cause conflicts between static and instance methods, for example:#model_Model-remove
refers to both instance and static remove, which is not correct.Also the
type_Type
is redundant, so it could be removed.Personally i would like to not have to use band-aids for special cases and just have it correctly separated.
My proposal would be:
#Type(.prototype).function
, real examples:#Model.remove
to refer to the static remove#Model.prototype.remove
to refer to the instance remove(basically like it is in JS directly)
i would target this towards 7.0 (because it would be a rather drastic change for the documentation.)
as for backwards compatibility (like bookmarks), we could add hidden elements that still have the same old header id and so could still refer to the same place (and maybe some script to translate it to the new id)
cc @vkarpov15 @Uzlopak
The text was updated successfully, but these errors were encountered: