Better document scalar_type, base_type, and value_type template concepts
Open
Nobody has claimed this yet.
doc
- Dominant language
- C++
- Stars
- 839
- Forks
- 220
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 14
Description
Stan::Math exposes value_type_t, base_type_t, and scalar_type_t. Here is what the docs have to say about each:
- value_type_t:
Helper function for accessing underlying type. - base_type_t:
(no documentation) - scalar_type_t:
(no documentation)
Additionally, there are require_ templates such as require_vt_complex, and require_st_complex where the st and vt stand for scalar type and value type respectively, which could also use clarification.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Stan::Math API entries for base_type_t and scalar_type_t, then compare them with the existing value_type_t documentation. Clarify these three concepts and the st/vt abbreviations used by require_vt_complex and require_st_complex; done means the generated documentation explains each consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100