robotframework / robotframework/robotframework-RFCP-syllabus

Describe in the description if alternate word is an Alias or Abbreviation

Open
#84 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

For clarity it's preferable to know when something is considered an 'alias' or 'abbreviation', this should be displayed in the glossary description entries rather than having only a 'green block' that could be either. We should have not both entries be the same. (As we are seeing that with for example gTAA)

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

Start by locating the glossary description entries and inspect the gTAA entry alongside the green-block indicator shown in the issue. Determine where the alias or abbreviation distinction is represented. Done means glossary entries explicitly identify which term is an alias or abbreviation and do not use identical descriptions where the distinction matters.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.