pymc-labs/CausalPy

Improve docstrings in `InversePropensityWeighting` class

Open

#388 geöffnet am 12. Juli 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (111 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (1.162 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Lesen Sie die Docstrings der Klasse InversePropensityWeighting und fügen Sie Beschreibungen für alle Argumente und Schlüsselwortargumente hinzu.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85