Skip to content

docs: fix 'seperate'/'seperated' typos in API docstring guidance and Spanner tracing docs - #18979

Open
Jah-yee wants to merge 1 commit into
googleapis:mainfrom
Jah-yee:fix/typo-seperate-separate-docs
Open

Jah-yee wants to merge 1 commit into
googleapis:mainfrom
Jah-yee:fix/typo-seperate-separate-docs

Conversation

@Jah-yee

@Jah-yee Jah-yee commented Nov 4, 2026

Copy link
Copy Markdown

Summary

Fixes two seperate / seperated typos in the documentation:

  • packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md
    • "inline link and seperate link" → "inline link and separate link"
    • the RST example anchor is now consistently spelled: .. _Separated Link: / \Separated Link`_(and the example URL hosthttp://separated.external.link`)
  • packages/google-cloud-spanner/docs/opentelemetry-tracing.rst
    • "# in a seperate thread to not block on the main thread" → "# in a separate thread to not block on the main thread"

Both files are documentation only — no library code paths are touched, so there is no behavior change and no test impact.

Why

The RST guidance page is the reference that library authors copy from when writing docstrings, so the misspelled anchor name in the example is what people end up copying. The Spanner tracing page has the same typo in the code sample that readers copy-paste into their own projects.

Note: the anchor rename is applied to both halves of the RST reference (the reference text \Separated Link`_and the target definition.. _Separated Link:`), so the example remains internally consistent and still demonstrates the same "separated link will fail" behavior the page is documenting.

@Jah-yee
Jah-yee requested review from a team as code owners November 4, 2026 02:34

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request corrects spelling mistakes in the documentation files, specifically fixing occurrences of 'seperate' and 'seperated' to 'separate' and 'separated' in How_to_Document_Python_API.md and opentelemetry-tracing.rst. There are no review comments, so I have no feedback to provide.

This branch has not been deployed

No deployments
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.

1 participant