From 55912018786fca56156b216f5b707b53ab9c8ef8 Mon Sep 17 00:00:00 2001 From: Jah-yee <166608075+Jah-yee@users.noreply.github.com> Date: Wed, 4 Nov 2026 10:34:40 +0800 Subject: [PATCH] docs: fix 'seperate'/'seperated' typos in API docstring guidance and Spanner tracing docs --- .../docs/How_to_Document_Python_API.md | 6 +++--- .../google-cloud-spanner/docs/opentelemetry-tracing.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md b/packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md index 370689bfb368..2991aa1fb931 100644 --- a/packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md +++ b/packages/gcp-sphinx-docfx-yaml/docs/How_to_Document_Python_API.md @@ -200,7 +200,7 @@ def method_exception(self): ## 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: @@ -208,9 +208,9 @@ But note that our tool only support inline external link format currently. As an def method_external_link(self): """ Docstring of :meth:`format.rst.foo.Foo.method_external_link`. Inline link should be transformed to markdown: `Link Text `_. - 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 ``` diff --git a/packages/google-cloud-spanner/docs/opentelemetry-tracing.rst b/packages/google-cloud-spanner/docs/opentelemetry-tracing.rst index c581d2cb877c..bafc17846e7d 100644 --- a/packages/google-cloud-spanner/docs/opentelemetry-tracing.rst +++ b/packages/google-cloud-spanner/docs/opentelemetry-tracing.rst @@ -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