stan-dev / stan-dev/docs

Bring GLM function doc in line with other functions

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

Nobody has claimed this yet.

Dominant language
TeX
Stars
43
Forks
133
Avg merge
11h 32m
Merged PRs (30d)
4

Description

In terms of naming arguments, inconsistencies in notation to iron out (little vs. big N for example in sizing, for example), etc.

Originally posted by @bob-carpenter in https://github.com/stan-dev/docs/pull/678#pullrequestreview-1801159337, see additional comments there

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 with the GLM function documentation and the additional comments in pull request 678, then compare its argument naming and sizing notation with the surrounding function documentation. Done means the GLM documentation follows the same naming and notation conventions as the other functions.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.