CDCgov / CDCgov/PyRenew

Latent Processes appear twice in documentation

Open
#760 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
29
Forks
9
Avg merge
9d 9h
Merged PRs (30d)
8

Description

For example, AR1 is presented here: https://cdcgov.github.io/PyRenew/reference/latent.html#pyrenew.latent.AR1 and identically here: https://cdcgov.github.io/PyRenew/reference/latent.html#pyrenew.latent.temporal_processes.AR1

I assume this is because we explicitly include pyrenew.latent.temporal_processes in the docs, which has the benefit of including the supporting material about Temporal Processes: https://cdcgov.github.io/PyRenew/reference/latent.html#temporal-processes, which is important context for users.

Is there some way to present the supporting material while only documenting the temporal processes once?

Contributor guide

No contributing guide indexed for this repository

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 by comparing the two AR1 entries and the Temporal Processes supporting material in the linked latent reference page. Inspect how pyrenew.latent.temporal_processes is included in the documentation, then determine whether the supporting material can remain while its process members are documented only once. Done means the reference page has one entry per temporal process and retains the needed context.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.