Fix malformed README quickstart fence and non-runnable timeout snippet

オープン 初心者向け
#176 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
python
領域
documentation

調査の方向性

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

  1. Render README.md on GitHub/PyPI, or track fence state from lines 27-68.
  2. Observe that lines 46-66 are outside the Python block and line 68 (## Examples) is inside the next fence.
  3. Copy the timeout block at lines 230-247 into a Python process; it raises NameError: name 'httpx' is not defined at 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 httpx for 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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

browserbase/sdk-python のほかの issue

browserbase/sdk-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。