dateutil/dateutil

documentation not generated for methods defined on rrulebase

Open

#677 opened on 2018年4月13日

GitHub で見る
 (1 comment) (2 reactions) (0 assignees)Python (2,189 stars) (470 forks)batch import
documentationhelp wantedmedium-difficultyrrule

説明

There seems to be some bug with the documentation generation for rrule.

For e.g. rrule.between does have a docstring

(https://github.com/dateutil/dateutil/blob/master/dateutil/rrule.py#L270)

but does not have any documentation (http://dateutil.readthedocs.io/en/stable/rrule.html).

Similarly for the methods 'after', 'xafter', etc.

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic PythonSphinx documentation generation
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
The issue reports that methods like rrule.between, after, and xafter have docstrings but are not included in the generated documentation. Investigate the Sphinx autodoc configuration in docs/conf.py and the module's all or autodoc settings. Check if the methods are defined on the base class (rrulebase) and whether autodoc is configured to skip inherited members or to include only explicitly listed methods. The fix likely involves adjusting the autodoc options to ensure all public methods with docstrings appear in the documentation.