lnccbrown / lnccbrown/HSSM

Add poisson race tutorial to docs properly

Open Beginner friendly
#916 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
124
Forks
24
Avg merge
19h 32m
Merged PRs (30d)
60

Description

We have a notebook that illustrates the behavior of the poisson race model in `docs/tutorials/poisson_race.ipynb`.

To complete this issue please add it to the `mkdocs.yaml` and test run this once more to make sure everything is kosher.

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.

Research direction

Start with docs/tutorials/poisson_race.ipynb and the mkdocs.yaml navigation or documentation configuration. Add the notebook to mkdocs.yaml, then test-run the documentation once more. Done means the Poisson race tutorial is included and the documentation build or test completes successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.