What should be included in the glossary?

Open
#593 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start by reviewing the current glossary and the reference entries it covers, then compare the proposed approach with the linked DADS, ISO 2382, and FOLDOC sources. Done means reaching and documenting a clear policy for terms such as “combinator” and for using external definitions.

Written by the indexing model from the issue text.

Description

A-glossary C-discussion

Decide what qualifies for inclusion in the glossary. If a term is never used in the reference (like "combinator"), should it be included? There are quite a few terms that are like this.

We may also consider deferring to external sources for terms of art instead of trying to define things ourselves. For example, DADS, ISO 2382, FOLDOC, etc.

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

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 rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.