Rendering of TeX equations in documentation
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- tex
- Domain
- documentation
Research direction
Start with the linked Boost.Random documentation pages and inspect how the TeX equations under “Description” are generated and rendered. Compare the inline equations with the PDF examples, then verify that the selected rendering change makes the terms readable at the affected sizes.
Written by the indexing model from the issue text.
Description
Some boost documentation uses TeX formulae, e.g. for the PDFs of distributions. Unfortunately these equations are rendered at a fixed low resolution, making the terms in some of them quite difficult to read (especially where the equations appear inline and contain things like \e ^ \frac ...). Examples (under "Description"):
https://www.boost.org/doc/libs/1_69_0/doc/html/boost/random/lognormal_distribution.html
https://www.boost.org/doc/libs/1_69_0/doc/html/boost/random/poisson_distribution.html
Please at least increase the rendering size. Other options might be to move these equations out-of-line (thus increasing size) or using mathjax.
- Dominant language
- C++
- Stars
- 42
- Forks
- 76
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 6
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from boostorg/random
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 2 days
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 2 days
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 2 days
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 2 days
-
Documentation
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Maintainers usually reply within 2 days
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
ChicoState/autovalidate#195 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
petercorke/robotics-toolbox-python#709 ·
Maintainers usually reply within 2 days
-
bug documentation LOW ui
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
mgradwohl/tasksmack#1212 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day