cplusplus / cplusplus/draft

[checks] Add checks for indexing of some operators

Open
#8,813 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

Due to some restrictions of LaTeX, these operators need to be escaped in indexing:

  • operator& -> operator\&
  • operator&& -> operator\&\&
  • operator&= -> operator\&=
  • operator% -> operator\%
  • operator%= -> operator\%=
  • operator~ -> operator\~{}
  • operator^ -> operator\caret
  • operator^= -> operator\caret=
  • operator! -> operator"!
  • operator!= -> operator"!=
  • operator""suffix -> operator""""suffix
  • operator| -> operator"|
  • operator|| -> operator"|"|
  • operator|= -> operator"|=

The current LaTeX source of working draft contains some unescaped forms in the indices, which makes some operators not correctly indexed in N5032.

Also, it's curious that unescaped | is correctly parsed in https://eel.is/c++draft/libraryindex.

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 indexing checks and the current LaTeX source that produces the draft index. Compare the listed operator forms with the indices in N5032 and the behavior shown by eel.is/c++draft/libraryindex. Done means the checks cover every listed escaped form and detect the currently unescaped cases without false failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, latex
Domain
documentation, testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.