Skip to content

docs(prompts): fix fetch_timeout_seconds unit in get_prompt docstring - #2087

Open
caiotheodoro wants to merge 1 commit into
langfuse:mainfrom
caiotheodoro:docs/get-prompt-fetch-timeout-unit
Open

caiotheodoro wants to merge 1 commit into
langfuse:mainfrom
caiotheodoro:docs/get-prompt-fetch-timeout-unit

Conversation

@caiotheodoro

@caiotheodoro caiotheodoro commented Nov 1, 2026 •

Copy link
Copy Markdown

What does this PR do?

Langfuse.get_prompt documents fetch_timeout_seconds as "The timeout in milliseconds". The value is passed straight to request_options["timeout_in_seconds"] and used as the httpx timeout, so it is seconds. Following the docstring and passing 5000 gives a ~83 minute timeout.

Checked against a local server that sleeps 4s before answering, max_retries=0:

fetch_timeout_seconds=1: ReadTimeout after 1.01s
fetch_timeout_seconds=2: ReadTimeout after 2.00s

Docstring-only change.

Type of change

  • Documentation update

Verification

uv run --frozen ruff check .
uv run --frozen ruff format --check .

Both pass with ruff 0.15.22. mypy langfuse reports 16 errors in my environment (14 missing langchain stubs, 2 in observe.py), none in _client/client.py; not changed by a docstring edit.

Checklist

  • I self-reviewed the diff using code_review.md.
  • I added or updated tests for behavior changes. (no behavior change)
  • I updated docs, examples, or .env.template if needed.
  • I did not hand-edit generated files.
  • I did not commit secrets or credentials.

Drafted with Claude Sonnet 5.5.

RetriggerView in GreptileConfidence Score: 5/5

This docstring correction appears safe to merge.

Summary

Corrects the Langfuse.get_prompt docstring to describe fetch_timeout_seconds in seconds rather than milliseconds.

  • get_prompt documents prompt fetch timeouts in seconds.

Reviews (1) · Last reviewed commit: "docs(prompts): fix fetch_timeout_seconds..." · Reviewed by Greptile

The argument is passed to the API client as timeout_in_seconds and is applied as an httpx timeout in seconds, but the docstring said milliseconds.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@CLAassistant

CLAassistant commented Nov 1, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants