pymc-labs/CausalPy

Improve docstrings in `InversePropensityWeighting` class

Open

#388 aperta il 12 lug 2024

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (111 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (1162 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Leggi le docstring della classe InversePropensityWeighting e aggiungi le descrizioni per tutti gli argomenti e gli argomenti chiave.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85