cplusplus / cplusplus/draft

[checks] Check for `in \xrefc`

Open Beginner friendly
#9,319 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

P3-Other
Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

Description

As seen in https://github.com/cplusplus/draft/pull/9318, there are some instances where \xrefc was mistakenly used like \ref, but it's a standalone element with a SEE ALSO preamble.

Both instances could have been prevented by checking for in +\\xrefc.

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 reviewing the examples in pull request 9318 and locating the existing checks that validate xrefc usage. Add coverage for the pattern "in \xrefc"; done means both mistaken instances are detected by the check.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.