Impossible to get single newlines in help text
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
調査の方向性
まず、Python 3.10.11 と Click 8.2.1 で、示されている click.option の例を使ってフォーマットを再現し、その後、空白と改行を担っているヘルプテキストのレンダリング経路を追跡します。追加の空行を必要とせずに、ドキュメントに記載された単一改行の形式が生成され、既存の代替形式も引き続き正しく動作すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The expected format is:
--annotations [disabled|comment]
Specify the type of annotations to include in the XML output.
'Disabled' - no annotations.
'Comment' - annotations as comments.
The actual format is either:
--annotations [disabled|comment]
Specify the type of annotations to include in the XML output.
'Disabled' - no annotations.
'Comment' - annotations as comments.
or:
--annotations [disabled|comment]
Specify the type of annotations to include in the XML output. 'Disabled' - no annotations. 'Comment' - annotations as comments.
However the text either has no newlines, or it has double newlines.
I expected this to work:
@click.option(
"--annotations",
type=click.Choice(Annotations, case_sensitive=False),
default=Annotations.Comment,
help="""Specify the type of annotations to include in the XML output.
\b
'Disabled' - no annotations.
'Comment' - annotations as comments.""",
)
But that ends up without any newlines.
Adding an extra blank line before the \b does work, but that also results in an extra blank line in the output (as seen above):
@click.option(
"--annotations",
type=click.Choice(Annotations, case_sensitive=False),
default=Annotations.Comment,
help="""Specify the type of annotations to include in the XML output.
\b
'Disabled' - no annotations.
'Comment' - annotations as comments.""",
)
Environment:
- Python version: 3.10.11
- Click version: 8.2.1
- 主要言語
- Python
- スター
- 17.8k
- フォーク
- 3.3k
- 平均マージ
- 3日 3時間
- マージ済み PR（30日）
- 13
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pallets/click のほかの issue
-
`show_envvar=True` Drops Environment Variable from Error Messages When Using `auto_envvar_prefix`オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
More private utilities that need to be marked and public api deprecated再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンtyping
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
pallets/click#3847 · コメント 9 件 ·
メンテナーはふだん 1 日以内に返信
-
Automatically append ellipsis (`...`) to metavars when `multiple=True` in options対応中かも @SparshGarg999 が 89 日前に担当しました。 オープンhelp output
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
pallets/click#3652 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
`HelpFormatter.write_usage` breaks options at a hyphen対応中かも @kdeldycke が 9 日前に担当しました。 オープンhelp output
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
pallets/click#3362 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
Add glossary of terms to click reference docs対応中かも @rohitbarhate111-commits が 55 日前に担当しました。 オープンdocs
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
pallets/click#3077 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
gke-labs/kube-agents#5671 ·
メンテナーはふだん 1 日以内に返信
-
docs(auth): Method B step 4 should tell users to tick "Use this client for an AI-powered agent"オープンdocumentation next-release v0.9.6
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
khuisman/mcp-gee-sweet#1446 ·
メンテナーはふだん 1 日以内に返信
-
model:sonnet runtime:claude security size:S
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
FootprintAI/Containarium#3671 ·
メンテナーはふだん 1 日以内に返信
-
HolidayBase: reassigning `language` does not re-initialize translations or re-populate holidays対応中かも @shikhabhadoria が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
vacanza/holidays#4116 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug CLI exec
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信