cplusplus / cplusplus/draft

[lib] Space between requires and its parameter list?

Open
#4,720 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Despite #4719, it is not at all clear whether there should be a space between "requires" and its parameter list.

Statistics: 74 places with space, 46 wihout.

fgrep "requires (" *.tex | wc -l

  • come up with a consistent rule
  • apply the rule everywhere
  • add a check

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 running the reported fgrep command over the *.tex sources and inspect the 74 spaced and 46 unspaced requires forms. Resolve the consistency rule, apply it throughout the sources, and add a check that detects future deviations; the issue names no specific test or checker entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.