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

Add rst-lint back to the lint utilities. #139

Closed
rjdbcm opened this issue Jan 28, 2024 · 0 comments · Fixed by #145
Closed

Add rst-lint back to the lint utilities. #139

rjdbcm opened this issue Jan 28, 2024 · 0 comments · Fixed by #145
Assignees
Labels
bug Something isn't working
Milestone

Comments

@rjdbcm
Copy link
Member

rjdbcm commented Jan 28, 2024

The lint checkpoint, and checkpoints in general, are to check that a project can be packaged, released, and published. Twine will fail to upload bad readme text and we should not be letting this happen.

This can't catch every issue see https://pypi.org/project/restructuredtext-lint/:

While a document may lint cleanly locally, there can be issues when submitted it to [PyPI](http://pypi.python.org/). Here are some common problems:

    Usage of non-builtin lexers (e.g. bibtex) will pass locally but not be recognized/parsable on [PyPI](http://pypi.python.org/)

        This is due to [PyPI](http://pypi.python.org/) not having a non-builtin lexer installed

        Please avoid non-builtin lexers to avoid complications

        For more information, see [#27](https://github.com/twolfson/restructuredtext-lint/issues/27)

    Relative hyperlinks will not work (e.g. ./UNLICENSE)

        According to Stack Overflow, hyperlinks must use a scheme (e.g. http, https) and that scheme must be whitelisted

            http://stackoverflow.com/a/16594755

        Please use absolute hyperlinks (e.g. https://github.com/twolfson/restructuredtext-lint/blob/master/UNLICENSE)

However, these are fair restrictions to have on a shared README file.

@rjdbcm rjdbcm added the bug Something isn't working label Jan 28, 2024
@rjdbcm rjdbcm added this to the Alpha Release milestone Jan 28, 2024
@rjdbcm rjdbcm self-assigned this Jan 28, 2024
rjdbcm added a commit that referenced this issue Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant