Skip to content

docs: add docstrings to public classes and functions#5267

Merged
leseb merged 3 commits intollamastack:mainfrom
gyliu513:doc
Mar 26, 2026
Merged

docs: add docstrings to public classes and functions#5267
leseb merged 3 commits intollamastack:mainfrom
gyliu513:doc

Conversation

@gyliu513
Copy link
Contributor

What does this PR do?

Test Plan

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Mar 24, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 24, 2026

✱ Stainless preview builds

This PR will update the llama-stack-client SDKs with the following commit message.

docs: add docstrings to public classes and functions
llama-stack-client-openapi studio

Your SDK build had a "fatal" conclusion, and no code was generated.

llama-stack-client-go studio

Your SDK build had a "fatal" conclusion, and no code was generated.

llama-stack-client-python studio

Your SDK build had a "fatal" conclusion, and no code was generated.

llama-stack-client-node studio

Your SDK build had a "fatal" conclusion, and no code was generated.


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-03-26 19:46:15 UTC

Copy link
Collaborator

@leseb leseb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just thought about something, @gyliu513 can we have a linter for this? so that we do not add code without doc strings?

@leseb
Copy link
Collaborator

leseb commented Mar 25, 2026

@gyliu513 please fix conflicst

@gyliu513 gyliu513 force-pushed the doc branch 5 times, most recently from f096d00 to 3921257 Compare March 26, 2026 13:00
@leseb leseb merged commit 37616f1 into llamastack:main Mar 26, 2026
115 of 116 checks passed
skamenan7 added a commit to skamenan7/llama-stack that referenced this pull request Mar 26, 2026
…ort.py

Upstream PR llamastack#5267 added a docstring to get_langid() in ifeval_utils.py.
Since that function now lives in ifeval_support.py after the split, carry
the docstring over to the correct location.

Signed-off-by: skamenan7 <skamenan@redhat.com>
leseb added a commit to leseb/llama-stack that referenced this pull request Mar 26, 2026
The merge with upstream/main brought in docstrings from PR llamastack#5267 which,
combined with the structlog migration changes, pushed stack.py to 1015
lines. Condensed multi-line Args/Returns/Raises docstrings into concise
single-line summaries to bring the file back under the pre-commit file
size limit.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
@gyliu513 gyliu513 deleted the doc branch March 26, 2026 20:04
skamenan7 added a commit to skamenan7/llama-stack that referenced this pull request Mar 26, 2026
…ort.py

Upstream PR llamastack#5267 added a docstring to get_langid() in ifeval_utils.py.
Since that function now lives in ifeval_support.py after the split, carry
the docstring over to the correct location.

Signed-off-by: skamenan7 <skamenan@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants