Token `StringContinuation` does not specify whitespace-consumption behavior
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
The whitespace-consumption behavior of StringContinuation (§2.4.6.1:2) is not defined. This behavior is defined in the Rust reference. A naïve implementation of StringContinuation based solely off of the FLS will incorrectly parse (note the whitespace):
"Multi\
line"
as equivalent to "Multi line", which is incorrect.
Instead, StringContinuation can be more accurately described as:
StringContinuationis the character sequence 0x5C 0x0A (reverse solidus, new line) followed by a whitespace string.
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
Open §2.4.6.1:2 in the FLS and compare the StringContinuation wording with the linked Rust reference. Clarify the specification using the stated character sequence, then verify that the multiline example is no longer interpreted as containing the indentation whitespace.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100