Inconsistency in description of string literals
Open
Nobody has claimed this yet.
A-lexer
C-enhancement
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
In the description of various string literals (on lexical-elements.rst):
RawByteStringContentis specified as taking arbitraryAsciiCharacters. This isn't true - 0x0D (CR) is still rejected, andAsciiCharacteris specified as "any Unicode character in the range 0x00 - 0x7F, both inclusive", without specifically excluding 0x0D. Note thatSimpleByteStringLiteralis defined instead in terms ofSimpleByteStringCharacter, which is specified to beAsciiCharacterminus 0x0D, 0x22, and 0x5C.RawCStringContentis specified as taking any characters except 0x0D (CR) (" ~[\r]* "), but raw C string literals also can't contain 0x00 (NUL).
Contributor 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.
Research direction
Start with src/lexical-elements.rst and compare the definitions of RawByteStringContent, SimpleByteStringCharacter, and RawCStringContent. Verify the documented exclusions for carriage return and NUL against the issue, then update the descriptions so they match the stated literal restrictions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100