Specify default values for all documented parameters

オープン
  • 何か問題がありますか？
#149 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

Start with the function docstrings in the cf-plot Python package, using the width=0.02 example from the issue as a model. Look for parameters that default to None and get their real value from an if not <kwarg> check in the function body, and note each actual default. Done when every documented parameter states its default value in its docstring, matching what the code does.

索引モデルが issue の本文から書いたものです。

説明

docs enhancement

There is currently mostly no indication of default values for the documented parameters in the function docstrings, and though in some cases this can be implied by the function signature (e.g. width=0.02), this isn't often a clue since in lots of cases the defaults are set after an if not <kwarg> check for None values. As per good (and indeed expected) docstring practice these should be added so the user knows what default value is used by the logic.

主要言語
Python
スター
21
フォーク
11
平均マージ
2日 21時間
マージ済み PR（30日）
7

環境構築

はじめの一歩

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

NCAS-CMS/cf-plot のほかの issue

NCAS-CMS/cf-plot の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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