Fix malformed README quickstart fence and non-runnable timeout snippet
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 82/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
README.md の 27-68 行目から始めて quickstart の fence を確認し、その後 230-247 行目の timeout の例を確認します。quickstart 全体を 1 つの Python fence 内に収め、timeout の snippet に必要な import が含まれていることを確認します。README をレンダリングし、スタンドアロンの snippet を実行して、例が実行可能であることを検証します。
索引モデルが issue の本文から書いたものです。
説明
Description
The README quickstart closes its Python fence immediately after session creation (README.md:43), leaving the Playwright run() function as plain Markdown, then opens an unintended fence at README.md:67. This corrupts the rendered structure around the primary usage example and the following Examples section.
A second runnable-snippet problem appears in the timeout example: README.md:241 calls httpx.Timeout(...), but that code block imports only Browserbase and never imports httpx.
Reproduction
- Render
README.mdon GitHub/PyPI, or track fence state from lines 27-68. - Observe that lines 46-66 are outside the Python block and line 68 (
## Examples) is inside the next fence. - Copy the timeout block at lines 230-247 into a Python process; it raises
NameError: name 'httpx' is not definedat line 241.
Expected behavior
- The entire quickstart (imports, session creation,
run(), and main guard) should be within one Python fence. - Each advertised standalone snippet should contain the imports it needs, including
import httpxfor the granular timeout example.
Actual behavior
The primary README example is malformed when rendered, and the timeout example is not executable as shown.
Why it matters
README content is also used for the package metadata/PyPI page, so these errors affect the first-run path for both GitHub and PyPI users. A lightweight docs test that extracts/compiles Python fences would prevent recurrence.
- 主要言語
- Python
- スター
- 93
- フォーク
- 16
- 平均マージ
- 11分
- マージ済み PR(30日)
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
browserbase/sdk-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
browserbase/sdk-python#182 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
browserbase/sdk-python#180 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
browserbase/sdk-python#179 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
browserbase/sdk-python#178 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
browserbase/sdk-python#175 ·
browserbase/sdk-python の issue をすべて見る
似ている issue
-
sponsored
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
Diaoul/subliminal#1382 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
triage/confirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
agentscope-ai/agentscope#2775 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100