CR in non-doc comments
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
§2.5:11 (fls_6fxcs17n4kw) reads:
Character 0x0D (carriage return) shall not appear in a comment.
But rustc does accept CR in non-doc comments.
Perhaps 'doc comment' was intended here instead of 'comment'.
But the syntax rules for doc comments were evidently written with the intent of excluding CR. So I think that (if #610 is fixed) this paragraph can be dropped altogether.
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
Locate §2.5:11 (fls_6fxcs17n4kw) in the FLS sources and compare its restriction with rustc's handling of CR in non-doc comments. Read issue #610 before deciding whether this paragraph should be revised or removed; done means the specification accurately describes the intended doc-comment syntax and rustc behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100