robotframework / robotframework/robotframework-RFCP-syllabus

Term should exist as a singular entry, aliases should not have their own entry

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
20
Forks
20
PR merge metrics
No merged PRs in 30d

Description

A Term should exist as 'a term', aliases should not have their own entry.

Aliases shouldn't have a 'separate' entry in glossaries, but ought to be mentioned just in the 'main entry' they can be searched with either specific or lazy search option. This can tighten the glossary a bit more instead of riddling it with additional 'terms' that are in fact only aliases.

A term should reflect the actual term, not alternates for it.
image

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.

Research direction

No files or tests are named; start by locating the glossary term and alias entry generation, then trace how the specific and lazy search options use them. Done means each term has one main glossary entry, aliases are mentioned there rather than listed separately, and both search modes still find the term.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.