uabrc / uabrc/uabrc.github.io

Acronyms need to be added to title case checker

Open
#1,016 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev: enhancement 🛠️✨
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

Acronyms like "UAB" are preserved correctly because they are listed in .title-case-ignore.

While other keywords or acronyms, for example "OOD". It passes the checker when written as "Ood", even though it should be "OOD".

I am raising this to suggest expanding the ignore list to better handle common acronyms and keywords in our title formatting.

Everyone is welcome to suggest additional acronyms or keywords, and we can add them over time.

@wwarriner, any suggestion on how best to handle this?

OOD

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 with the .title-case-ignore file and the title case checker mentioned in the issue. Add or verify acronym handling for OOD, then run the checker against both OOD and Ood; done means the correctly capitalized form passes and the incorrectly cased form is rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.