Skip to content

docs: fix network file format, transition rules, and orphaned page#6

Merged
AdishAssain merged 1 commit into
mainfrom
docs/fix-inaccuracies
May 26, 2026
Merged

docs: fix network file format, transition rules, and orphaned page#6
AdishAssain merged 1 commit into
mainfrom
docs/fix-inaccuracies

Conversation

@AdishAssain
Copy link
Copy Markdown
Member

Documentation corrections found during UAT (PyPI install wording intentionally left unchanged).

  • NetworkFile format: configuration.md showed source,target,weight, but the loader requires a leading day column. Updated the example to day,source,target,weight with self-loops, and documented day.
  • Transition rule: clarified that an expression naming the source compartment is used as-is, otherwise it's multiplied by the source — so gamma and gamma * I are equivalent (both give gamma * I). Documented that S -> I: beta becomes the network force of infection in multi-patch models, and that single-patch models need an explicit I term.
  • network-design.md: corrected the claim that weights are auto-normalized to sum to 1 — they are used as given.
  • index.md: added architecture.md to the toctree (it was orphaned; this also makes the -W Sphinx build clean).

- configuration.md: NetworkFile example now shows the required `day` column
  (day,source,target,weight) with self-loops, and documents it
- configuration.md: clarify the transition rate rule — an expression naming the
  source compartment is used as-is, otherwise it's multiplied by the source
  (so `gamma` and `gamma * I` are equivalent); document S->I network FOI
- network-design.md: weights are used as given, not auto-normalized (the prior
  "rows are normalized to sum to 1" claim was inaccurate)
- index.md: add architecture.md to the toctree (was orphaned)
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

Warning

Review limit reached

@AdishAssain, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 5 minutes and 16 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c523db37-959e-4740-877b-70f74bd50a48

📥 Commits

Reviewing files that changed from the base of the PR and between c82fe49 and 37308d9.

📒 Files selected for processing (3)
  • docs/configuration.md
  • docs/index.md
  • docs/network-design.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-inaccuracies

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@AdishAssain AdishAssain merged commit 5f608cf into main May 26, 2026
3 checks passed
@AdishAssain AdishAssain deleted the docs/fix-inaccuracies branch May 26, 2026 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant