pymc-labs/CausalPy

Improve docstrings in `InversePropensityWeighting` class

Open

#388 opened on Jul 12, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (111 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,162 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Read the InversePropensityWeighting class docstrings and add descriptions for all arguments and keyword arguments.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85