Automatic capitalization of references
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 56.1k
- Forks
- 1.7k
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 22
Description
Description
At the moment @section_test always gets capitalized as Section 1.1, even when it is not the first word in the sentence. The same applies to figures and other types of references.
While it is possible to manually correct the capitalization for each reference, that process is tedious.
Disclaimer: I have no idea about the best way that this feature should be accessed (maybe as a show rule?) and also have no idea about the problems with other languages.
Here is the start of a small discord conversation about this, not sure what part of that is relevant.
I will try to get a workaround going, but I have to submit my masters thesis in a few days, so I am not sure that I will have the time to do so.
Use Case
This feature would make the output document better and make writing easier for users, by automatically selecting the correct capitalization of references.
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 by tracing how @section_test, figure references, and other references are rendered and where their capitalization is selected. The issue names no files or tests, so first determine the relevant reference-rendering entry points and review the linked discussion before deciding how language-specific behavior should work. Done means references are capitalized appropriately by sentence position without requiring manual correction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100