docs: fix misspellings in JSDoc and the generated API reference - #3131
Open
vaibhav8a wants to merge 1 commit into
Open
docs: fix misspellings in JSDoc and the generated API reference#3131vaibhav8a wants to merge 1 commit into
vaibhav8a wants to merge 1 commit into
Conversation
overriden -> overridden, fucntion -> function, seperated -> separated, specifed -> specified, persistant -> persistent. docs/API-Reference/ is generated from JSDoc, so each fix is applied to the source comment and to the generated page, keeping the two in sync.
|
Member
|
Thanks for the contributing @vaibhav8a . The changes looks good. Can you just comment, "I grant permission to distribute my contributions in this pull request under MIT License Terms." for me to be able to merge this. |
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
2 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.
Fixes five misspellings that appear in both the JSDoc comments and the API reference generated from them.
overridenoverriddensrc/command/KeyBindingManager.js,src/preferences/PreferencesManager.js,src/editor/CodeHintList.jsfucntionfunctionsrc/features/QuickViewManager.js,src/preferences/StateManager.jsseperatedseparatedsrc/utils/EventManager.js,src/view/ThemeManager.jsspecifedspecifiedsrc/view/Pane.js(×2)persistantpersistentsrc/widgets/PopUpManager.jsdocs/API-Reference/**is generated from these JSDoc blocks, so fixing only the markdown would be undone on the next docs build. Each correction is therefore applied to the source comment and to the corresponding generated page (KeyBindingManager.md,QuickViewManager.md,StateManager.md,EventManager.md,Pane.md,PopUpManager.md) so the committed tree matches what the generator would now emit.Comments and documentation only — no identifiers, APIs, or behaviour touched. I skipped the same spelling in
src/styles/bootstrap/, which is vendored third-party code.If you'd rather regenerate the docs yourselves, I can drop those six files and leave just the source comments.