cplusplus / cplusplus/draft

Grammar index broken by #1858

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

The changes from #1858 have caused a large number of index key errors in the grammar index, which show up as warnings in the index log file.

This is bad; we rely on clean logs to spot actual indexing errors. I was very close to adding an index log presubmit check, which would have blocked the application of the pull request.

Can you please fix this? (Perhaps by stripping out the formatting from the index key?)

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 changes from #1858 and the warnings in the index log file to identify how grammar index keys are being generated incorrectly. Investigate whether formatting is included in those keys, then verify that the grammar index produces clean logs without losing the required entries.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.