microsoft/vasim

Add comments and docstrings

Open

#6 opened on Aug 30, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Python (7 forks)auto 404
TODOdocumentationhelp wanted

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the recommender and simulator modules, understand the data window formation logic, and add docstrings and comments to clarify the predictive forecasting process.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75