Fix typos in code comments and one assert message - #213
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
Corrects 9 verified spelling/typo issues. All but one are inside JSDoc or // comments; no identifier is renamed. - modules/mlvis-common/src/utils/kmeans.js: 'distnace' -> 'distance' (x2), 'nInscances' -> 'nInstances' (x4) - all in JSDoc/inline comments; the misspelling is never used as an identifier. - modules/manifold/src/utils/kepler-utils.js: 'agregated' -> 'aggregated'. - modules/manifold/src/actions/io-actions.js: TODO comment referenced 'parsePromse'; the real imported symbol is 'parsePromise'. - modules/manifold/src/selectors/compute.js: the assert message 'must provide `nClusters for automatic segmentation' was missing its closing backtick, unlike the parallel 'segmentFilters' assert above it. Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
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
1 participant
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
Fixes 9 verified typos, 8 of them in JSDoc /
//comments and 1 in anassert()message. No identifier is renamed. EveryWrongstring was re-checked against livemaster(ef5088c) immediately before editing.distnace->distance(JSDoc example prose, lines 100 and 105) andnInscances->nInstances(shape annotations, lines 58, 81, 84 and 114).nInscancesis never used as an identifier anywhere in the repo - it only ever appears inside comments, and the surrounding annotations already spell itnInstances(e.g. lines 5, 38, 55, 180).// no need to create 2 layers if this is an agregated layer->aggregated.`parsePromse`; the real symbol isparsePromise, imported on line 2 and used on line 52. Comment only.'must provide `nClusters for automatic segmentation'was missing its closing backtick. The parallel assert six lines above correctly reads'must provide `segmentFilters` for manual segmentation'.Please note
The
compute.jschange is the only one that is not purely a comment: it alters the text of anassert()message that a developer would see whennClustersis missing. No test in the repo asserts on that string (grepped forfor automatic segmentation- the source line is the only hit), so nothing should break, but it is worth a look.Deliberately not changed
idsInSegmentgroupsinkepler-utils.jsand_renderXAxiesinjupyter-ma-causal/.../multi-line-chart/index.jswere flagged by the same scan, but both are real identifiers (a function parameter declared at lines 44, 78 and 142, and a class method defined at line 74 and called at line 261). Renaming them is out of scope for a typo PR, and the@paramtags must keep matching the actual parameter names, so they are left untouched.CLA
The contributor has signed / is signing Uber's Contributor License Agreement at https://cla-assistant.io/uber/manifold, as required by CONTRIBUTING.md. The cla-assistant check should go green on this PR.
Testing
CONTRIBUTING.md asks for "appropriate test cases" with each patch. This change touches only comments and one assertion message, so there is no behaviour to add a test for; no existing test references any of the changed strings.