pymc-labs/CausalPy

Improve docstrings in `InversePropensityWeighting` class

Open

#388 ouverte le 12 juil. 2024

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (111 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (1 162 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Lisez les docstrings de la classe InversePropensityWeighting et ajoutez des descriptions pour tous les arguments et arguments de mot clé.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85