More description needed for option `mathmlSpacing`

Open
#311 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start with options/output/index.rst and compare the documented mathmlSpacing and TexRules entries. Read the related source code and existing issues referenced by the reporter to establish the precise difference, then add clear explanations and an example for each option; the documentation should let readers distinguish their effects without repeating that investigation.

Written by the indexing model from the issue text.

Description

The documentation for options need more information for mathmlSpacing vs TexRules.

I've spent 30 minutes reading through issues and source code but it is still not clear to me precisely what this option does.

It would be great to have an example for each option clearly highlighting the differences.

Dominant language
JavaScript
Stars
553
Forks
235
No merged PRs in 30d

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.

More from mathjax/MathJax-docs

All issues in mathjax/MathJax-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.