Handle term definitions without an actual definition
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
In some cases, the :dt: tag has been used to define "pseudo terms" which do not have an actual definition. An example of such term is "identifier pattern matching" (see here). The term acts as a label for a sequence of dynamic semantics.
Given the work on https://github.com/rust-lang/fls/issues/680, such terms will pose a problem to the glossary generator. The terms will most likely need to be either removed, or fully defined.
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 reviewing the glossary-generator work in issue #680 and the “identifier pattern matching” example at patterns.html#identifier-pattern-matching. Find other :dt: tags used as labels without definitions, then determine whether each should be removed or fully defined. Done means pseudo terms no longer block the glossary generator.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100