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

check_missing_space_after_literal false positive #36

Open
JulienPalard opened this issue Jun 18, 2022 · 2 comments
Open

check_missing_space_after_literal false positive #36

JulienPalard opened this issue Jun 18, 2022 · 2 comments

Comments

@JulienPalard
Copy link
Collaborator

see: sphinx-doc/sphinx#10389 (comment)

@JulienPalard
Copy link
Collaborator Author

@AA-Turner I can't reproduce the false positive you mentionned in sphinx-doc/sphinx#10389 (comment), see: #37 any idea?

@AA-Turner
Copy link
Member

There was an error in the Sphinx docs, but I was confused by the warnings from Sphinx-lint, and then accidentally fixed it.

This reST:

The version of Docutils used to build represented as a tuple of five elements.
For Docutils version 0.16.1 beta 2 this would be `(0, 16, 1, 'beta', 2)``.
The fourth element can be one of: ``alpha``, ``beta``, ``candidate``, ``final``.
``final`` always has 0 as the last element.

yields these warnings:

(sphinx) I:\Development\sphinx>sphinx-lint templating.rst
templating.rst:2: inline literal missing (escaped) space after literal: '``.\nThe fourth element can be one of: ``a' (missing-space-after-literal)
templating.rst:3: inline literal missing (escaped) space after literal: '``, ``b' (missing-space-after-literal)
templating.rst:3: inline literal missing (escaped) space after literal: '``, ``c' (missing-space-after-literal)
templating.rst:3: inline literal missing (escaped) space after literal: '``, ``f' (missing-space-after-literal)
templating.rst:3: inline literal missing (escaped) space after literal: '``.\n``f' (missing-space-after-literal)

I'd expect to see a single warning about an improperly opened inline-literal, and the space after literal false positives confused me.

Sorry for the false report, but I think there could be a usability improvement here.

A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants