Skip to content

Fix typos and grammar errors in docs and source code#5542

Open
yangsong97 wants to merge 1 commit intoplotly:mainfrom
yangsong97:fix-documentation-typos
Open

Fix typos and grammar errors in docs and source code#5542
yangsong97 wants to merge 1 commit intoplotly:mainfrom
yangsong97:fix-documentation-typos

Conversation

@yangsong97
Copy link

@yangsong97 yangsong97 commented Mar 19, 2026

Summary

Fix 39 errors across 30 hand-written files (no changes to generated code).

Spelling fixes (15)

  • seperate -> separate (utils.py, _facet_grid.py)
  • auxilary -> auxiliary (callbacks.py, 2 instances)
  • immediatly -> immediately (basewidget.py)
  • paramter -> parameter (png.py)
  • coresponding -> corresponding (2d-projection-of-3d-surface.md)
  • indicies -> indices, verticies -> vertices (_trisurf.py, renderer.py)
  • coverted -> converted, specificed -> specified, legnth -> length, aswell -> as well (colors/__init__.py)
  • vica versa -> vice versa (v4-migration.md)
  • explictly -> explicitly (pattern-hatching-texture.md)
  • Ploty -> Plotly (__init__.py, io/__init__.py)

Double word fixes (13)

  • the the -> the (CONTRIBUTING.md, parallel-categories-diagram.md, selections.md, text-and-annotations.md, carpet-plot.md)
  • to to -> to (offline.py, basedatatypes.py)
  • is is -> is, and and -> and, on on -> on, a a -> a, that that -> that, in in -> in, be be -> be, a an -> an

Grammar fixes (6)

  • a integer -> an integer in basevalidators.py (this template string propagates to 500+ generated files)
  • a HTML report or an website -> an HTML report or a website (offline.py, 2 instances)
  • a object -> an object (basedatatypes.py)
  • it's -> its as possessive (basedatatypes.py)
  • diagnoses -> diagnose wrong verb form (ml-regression.md)

Broken link fixes (1)

  • Fix empty [Box plots]() and [violin plots]() links in categorical-axes.md

Note on generated files

Errors in plotly/graph_objs/ (e.g., "the the", "to to", "with with" in violin/scattercarpet/scatterternary docstrings) originate from codegen/resources/plot-schema.json which comes from plotly.js upstream. Those are not addressed here.

Test plan

  • All changes are to comments, docstrings, and documentation — no functional code changes
  • Verify no test regressions

Fix 39 errors across 30 files in hand-written source code and documentation:

Spelling fixes:
- "seperate" -> "separate" (utils.py, _facet_grid.py)
- "auxilary" -> "auxiliary" (callbacks.py, 2 instances)
- "immediatly" -> "immediately" (basewidget.py)
- "paramter" -> "parameter" (png.py)
- "coresponding" -> "corresponding" (2d-projection-of-3d-surface.md)
- "indicies" -> "indices", "verticies" -> "vertices" (_trisurf.py, renderer.py)
- "coverted" -> "converted", "specificed" -> "specified", "legnth" -> "length",
  "aswell" -> "as well" (colors/__init__.py)
- "vica versa" -> "vice versa" (v4-migration.md)
- "explictly" -> "explicitly" (pattern-hatching-texture.md)
- "Ploty" -> "Plotly" (__init__.py, io/__init__.py)

Double word fixes:
- "the the" -> "the" (5 instances in .md files, 1 in CONTRIBUTING.md)
- "to to" -> "to" (offline.py, basedatatypes.py)
- "is is" -> "is" (marker-style.md)
- "and and" -> "and" (v4-migration.md)
- "on on" -> "on" (ecdf-plots.md)
- "a a" -> "a" (outlier-test.md)
- "that that" -> "that" (normality-test.md)
- "in in" -> "in" (CHANGELOG.md)
- "be be" -> "be" (test_lazy_imports.py)
- "a an" -> "an" (axes.md)

Grammar fixes:
- "a integer" -> "an integer" (basevalidators.py - fixes 500+ generated files)
- "a HTML report or an website" -> "an HTML report or a website" (offline.py)
- "a object" -> "an object" (basedatatypes.py)
- "it's" -> "its" as possessive (basedatatypes.py)
- "diagnoses" -> "diagnose" wrong verb form (ml-regression.md)

Broken link fixes:
- Fix empty links for [Box plots]() and [violin plots]() (categorical-axes.md)
@camdecoster camdecoster self-assigned this Mar 20, 2026
@camdecoster
Copy link
Contributor

Thanks for the PR! I'll take a look and follow up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants