ipython / ipython/traitlets

document min, max kwargs to traitlets.{Int,Float}

未关闭
#357 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
good first issue
主要语言
Python
星标
653
派生
217
平均合并
2 天 21 小时
30 天内合并 PR
2

描述

The `min` and `max` kwargs are "manually" implemented as kw-only args to `Int` and `Float`. As a consequence, they do not appear in the generated docs (https://traitlets.readthedocs.io/en/stable/trait_types.html#numbers) anywhere AFAICT. I think sphinx allows manually overriding the signature to e.g. use the Python3-format (`Int(default_value=Undefined, allow_none=False, *, min=None, max=None, **kwargs)`) in the docs.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。