Option to not format module description docstring
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
調査の方向性
issue にはファイルやテストの名前が記載されていません。まず docformatter のオプション解析と、モジュール説明の docstring をフォーマットするコードを見つけ、次にフォーマットオプションに関する既存のテストを調べてください。ユーザーが設定できるオプションによってモジュール説明の docstring がスキップされ、モジュール内の他の docstring は引き続きフォーマットされれば完了です。
索引モデルが issue の本文から書いたものです。
説明
My organisation currently has a license header which doesn't conform to PEP 257, but I'd love to use docformatter for the rest of the module's contents.
I attempted to do this using the range option, but since the module description string also contains the module's description, one can know a minimum length for them, but not a maximum length.
It would be really great if docformatter had an option to toggle formatting of these module docstrings.
Thanks!
- 主要言語
- Python
- スター
- 598
- フォーク
- 97
- 平均マージ
- 1日 8時間
- マージ済み PR（30日）
- 11
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
PyCQA/docformatter のほかの issue
-
fresh
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
PyCQA/docformatter#399 ·
メンテナーはふだん 1 日以内に返信
-
1.7.8 crashes with a tokenize ValueError on a multi-line f-string inside parentheses再び着手できるかも @adityaanikam が 77 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンC: convention P: bug U: high
難易度 3/5 1〜2日 初心者へのやさしさ 74/100
PyCQA/docformatter#367 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
1.7.8 rewrites the contents of a non-docstring triple-quoted string, silently changing its valueオープンC: convention P: bug U: high
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
PyCQA/docformatter#366 ·
メンテナーはふだん 1 日以内に返信
-
C: stakeholder P: enhancement U: low
難易度 3/5 1〜2日 初心者へのやさしさ 65/100
PyCQA/docformatter#346 ·
メンテナーはふだん 1 日以内に返信
-
C: convention P: bug U: high
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
PyCQA/docformatter#345 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
PyCQA/docformatter の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
UKGovernmentBEIS/optstop#10 ·
-
maintenance
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
pollen-robotics/reachy_mini#1508 ·
メンテナーはふだん 1 日以内に返信
-
[BUG] `cloud-keys.env` values retain enclosing quotes causing 401 Unauthorized, and missing utf-8 encoding crashes on Windows対応中かも @divyanshu07-code が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
open-jarvis/OpenJarvis#1192 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
sylvainmetayer/homelab#851 ·
メンテナーはふだん 1 日以内に返信