pymc-labs/CausalPy

Improve docstrings in `InversePropensityWeighting` class

Open

#388 创建于 2024年7月12日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (111 fork)auto 404
documentationgood first issue

仓库指标

Star
 (1,162 star)
PR 合并指标
 (PR 指标待抓取)

描述

There is scope to improve the docstrings in the InversePropensityWeighting class. While the class does have good docstring coverage, and describes the purpose of the method, it does not always describe what the args/kwargs are.

Tagging @NathanielF, if you're interested?

NOTE: Do this after #381 is merged.

贡献者指南

研究方向
阅读 InversePropensityWeighting 类的文档字符串，并为所有参数和关键字参数添加描述。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Python
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85