microsoft / microsoft/vasim

Add comments and docstrings

Open
#6 0 comments 0 reactions 1 assignee View on GitHub

@apavlen is already working on this.

Since Sep 20, 2024.

documentation help wanted TODO
Dominant language
Python
Stars
12
Forks
11
Avg merge
7d 23h
Merged PRs (30d)
3

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.