Document that matching removes highlights from footnotes
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript
- Domain
- documentation
Research direction
Read the "What gets copied" section of docs/SPEC.md to confirm the null-highlight behavior, then open the "How it works" section of README.md. Add one or two sentences saying that highlight color is copied and that a match from an unhighlighted footnote removes highlights from all footnotes. Done when the README describes what the spec says, with no code changes.
Written by the indexing model from the issue text.
Description
Summary
By design (see docs/SPEC.md, "What gets copied"), when the source character has no highlight, BACKGROUND_COLOR is saved as null and applying the style removes highlights from all footnotes. This includes highlights a user added on purpose to particular footnotes.
The behavior is intended, but the README doesn't mention it, so it may surprise users.
Suggested change
Add a sentence to the "How it works" section of README.md, e.g.: "Highlight color is copied too. If the footnote you match from has no highlight, highlights are removed from all footnotes."
Optionally, consider whether the add-on should leave highlights alone instead (a behavior change that would need a spec update).
Generated by Claude Code
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 6m
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Tanman310/footnote-matcher
-
bug good first issue
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
bug
Difficulty 3/5 Half a day Newbie friendliness 48/100
All issues in Tanman310/footnote-matcher
Similar issues
-
accessibility area: css area: web ui bug difficulty: easy frontend good first issue help wanted javascript journey: first-visit journey: mobile priority: P3 quality tech: css tech: html typescript ui user-experience
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
themactep/thingino-firmware#2018 ·
Maintainers usually reply within 1 day
-
[analytics-core] getQueryParams does not decode `+` as space and truncates values containing `=`Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
amplitude/Amplitude-TypeScript#2179 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
cloudinary/js-url-gen#608 ·
-
ci: raise .github/workflows/test.yml timeout-minutes from 20 to 35 as suite exceeds 30,899 testsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Jason-Vaughan/TangleClaw#3075 ·
Maintainers usually reply within 1 day