Repository navigation
Conversation
…Spanner tracing docs
Contributor
There was a problem hiding this comment.
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
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
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 two
seperate/seperatedtypos in the documentation:packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md.. _Separated Link:/\Separated Link`_(and the example URL hosthttp://separated.external.link`)packages/google-cloud-spanner/docs/opentelemetry-tracing.rstBoth 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.