Repository navigation
docs(genai): clarify standalone library usage and manual examples - #294
Merged
Merged
Conversation
steverao
approved these changes
Oct 29, 2026
This was referenced Oct 29, 2026
pylaterreur
added a commit
to pylaterreur/loongsuite-python
that referenced
this pull request
Oct 30, 2026
alibaba#294 added extended_types to the API docs. Napoleon reads the first line of an attribute docstring written as "Name: text" as "type: description", so the "Streaming:" prefix of InvokeAgentInvocation.monotonic_first_token_s became a py:class reference to "Streaming". Nitpicky mode reports it and -W makes it an error, so the docs job fails on every pull request since alibaba#294. Reword the docstring. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GwUvhmzgfkiZ6vo4uGyesN
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.
Description
Manual rerank examples assigned unknown Python attributes, so document inputs, outputs, and counts could be silently omitted. Correct the field names and consistently construct Invocation objects before starting Handler lifecycles.
Present GenAI Utils as a standalone open-source library: the application installs the library and configures standard OpenTelemetry SDK providers/exporters before creating a Handler. Remove launcher, commercial-bridge, and platform-injection guidance from the usage flow; retain storage backends as optional extensions. Clarify existing content/event coverage, field mappings, context lifetimes, and troubleshooting, and expose the extended public API in the documentation.
This change is limited to four documentation files and preserves runtime code and telemetry field definitions.
Fixes # (N/A)
Type of change
How Has This Been Tested?
tox -e precommitwith a fresh hook cache; all four hooks passed.python -m sphinx -E -W -b html -C -D extensions=sphinx.ext.autodoc,sphinx.ext.napoleon -D autodoc_typehints=none -D root_doc=instrumentation-genai/util -D include_patterns=instrumentation-genai/util.rst docs /tmp/loongsuite-genai-apireadme_renderer.rst.render; embedded Python snippets passed syntax checks.SPAN_ONLYandNO_CONTENTprocesses; verified parent/child IDs, typed document count, model/provider attributes, and document content visibility.opentelemetry.instrumentationpackage.git diff --checkValidation used Python 3.14.8, OpenTelemetry SDK 1.45.1, and Sphinx 9.2.0.
Validation Evidence
response.idremained aMagicMockaftermodel_copy()). Those source/test files are unchanged by this documentation PR; updated-head checks will rerun.Does This PR Require a Core Repo Change?
Checklist: