pymc-labs/CausalPy

Improve docstrings in `InversePropensityWeighting` class

Open

#388 aberto em 12 de jul. de 2024

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

Métricas do repositório

Stars
 (1.162 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Leia as docstrings da classe InversePropensityWeighting e adicione descrições para todos os argumentos e argumentos de palavra chave.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85