Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

regression (1.4 => devel): rst: paragraph incorrectly created on line break, in 1st line of a list #17249

Closed
timotheecour opened this issue Mar 4, 2021 · 1 comment · Fixed by #17257
Labels
Documentation Generation Related to documentation generation (but not content). Regression

Comments

@timotheecour
Copy link
Member

timotheecour commented Mar 4, 2021

Example

Conventions
-----------
1. New stdlib modules should go under `Nim/lib/std/`. The rationale is to require
users to import via `import std/foo` instead of `import foo`, which would cause
potential conflicts with nimble packages. Note that this still applies for new modules
in existing logical directories, e.g.:
use `lib/std/collections/foo.nim`, not `lib/pure/collections/foo.nim`.

2. New module names should prefer plural form whenever possible, e.g.:
`std/sums.nim` instead of `std/sum.nim`. In particular, this reduces chances of conflicts
between module name and the symbols it defines. Furthermore, module names should
use `snake_case` and not use capital letters, which cause issues when going
from an OS without case sensitivity to an OS with it.

Current Output

the bug is that there is a new paragraph after The rationale is to require and after possible, e.g.:
image

Expected Output

image

Additional Information

@timotheecour timotheecour added Regression Documentation Generation Related to documentation generation (but not content). labels Mar 4, 2021
@a-mr
Copy link
Contributor

a-mr commented Mar 4, 2021

@timotheecour Thanks, well spotted. Also this problem is present in 2 other places in the nim repo.

However you are not quite right: RST requires to have indentation on the second and subsequent lines of enum.item, otherwise the entire thing should be parsed as a single paragraph.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Generation Related to documentation generation (but not content). Regression
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants