microsoft/vasim

Add comments and docstrings

Aberta

#6 aberto em 30 de ago. de 2024

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (1 responsável)Python (7 forks)auto 404
TODOdocumentationhelp wanted

Métricas do repositório

Stars
 (12 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

We especially need comments/docs in recommender and simulator. A lot of these can be autogenerated and then heavily edited.

I think we need to especially clarify the way the data window is formed in the predictive forecasting, etc.

### Tasks
- [ ] https://github.com/microsoft/vasim/issues/61

Guia do colaborador

Direção de pesquisa
Inspecione os módulos recommender e simulator, entenda a lógica de formação da janela de dados e adicione docstrings e comentários para esclarecer o processo de previsão.
Pilha de tecnologia
python
Domain
backend
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
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75