docs: complete Google-style docstrings for the public API#26
Merged
Conversation
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.
A docstring audit for the documentation site found most
ObservationandGenerationmethods undocumented and several public entry points at one-line stubs. The docs site generates its API reference from these docstrings, so they are now the single source of truth for reference documentation.What changed (docstrings only, no behavior):
Observation: class + all five methods (set_input,set_output,set_attribute,update,end), documenting serialization and the manual-vs-context-manager end() contract.Generation: class + all seven methods, documenting message normalization, default roles, the tokens-not-cost convention, and the emittedgen_ai.*attributes.observe(): full Args/Returns, incl. generator semantics and exception behavior.resolve_config(): precedence rules, env var names, clamping;GlassflowConfigclass docstring.GlassflowClient+get_tracer,build_span_exporter,start_generation/start_as_current_generationArgs/Returns,SpanKindvariant descriptions.Gates: ruff check, ruff format --check, mypy strict, pytest all green.