Add cross-references after adding hyperref per #36
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 405
- PR merge metrics
- No merged PRs in 30d
Description
#36
Please put a hypertarget and hyperlink for some symbols. For instance, when I read the epsilon symbol for 2.11, I had to scroll back up (to 2.5) to remind myself what that was. With hyperrefs I could click the ref, read the target, and scroll back to where I was or use CTRL+F. Similarly, hypertargets and hyperlinks for “dependency”, “later”, “latest messages”, and “validator weights” on p. 7, 3.1, would be helpful for a refresher, particularly the latest message. Also for the helper function. Alternatively or additionally as @MicahZoltu suggested just have more meaningful variable names. Looking at other literature, the convention is to use single character variables. So just use hypertargets and hyperrefs, if anything, unless you want to break with convention.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing issue #36 and locating the document sections around 2.5, 2.11, and 3.1, including page 7. Check how hyperref is already configured, then identify the referenced symbols, dependency, later, latest messages, validator weights, and helper function. Done means the requested targets and cross-references work throughout the document.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- latex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100