Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jah-yee wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,17 +200,17 @@ def method_exception(self):
<!-- ## Images -->
## External Links

External links can be written in two formats in RST: inline link and seperate link. Read more [here](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links).
External links can be written in two formats in RST: inline link and separate link. Read more [here](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links).

But note that our tool only support inline external link format currently. As an example:

``` python
def method_external_link(self):
""" Docstring of :meth:`format.rst.foo.Foo.method_external_link`.
Inline link should be transformed to markdown: `Link Text <http://inline.external.link>`_.
And seperated link will fail: `Seperated Link`_
And separated link will fail: `Separated Link`_

.. _Seperated Link: http://seperated.external.link
.. _Separated Link: http://separated.external.link
"""
pass
```
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-spanner/docs/opentelemetry-tracing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We also need to tell OpenTelemetry which exporter to use. To export Spanner trac
from opentelemetry.sdk.trace.sampling import TraceIdRatioBased
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter
# BatchSpanProcessor exports spans to Cloud Trace
# in a seperate thread to not block on the main thread
# in a separate thread to not block on the main thread
from opentelemetry.sdk.trace.export import BatchSpanProcessor

# Create and export one trace every 1000 requests
Expand Down
Loading