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.

Sign up for GitHub

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

Jump to bottom

Lint documentation writing style using Vale #237

Open
llucax opened this issue Mar 26, 2024 · 0 comments
Open

Lint documentation writing style using Vale #237

llucax opened this issue Mar 26, 2024 · 0 comments
Labels
part:ci Affects the GitHub workflow and other parts for running CI part:nox Affects the configuration of nox part:template Affects the cookiecutter template files type:enhancement New feature or enhancement visitble to users
Milestone
Untriaged

Comments

@llucax
Copy link
Contributor

llucax commented Mar 26, 2024 •
edited
Loading

What's needed?

It would be nice to have a more automated writing style correction, so we don't have to spend so much time on it during rewiews, and to ensure a more consistent style. Same as pydocstyle but on steroids and beyond Python.

Proposed solution

Use https://vale.sh/ and integrate it in the CI.
@llucax llucax added type:enhancement New feature or enhancement visitble to users part:nox Affects the configuration of nox part:ci Affects the GitHub workflow and other parts for running CI part:template Affects the cookiecutter template files labels Mar 26, 2024
@llucax llucax added this to the Untriaged milestone Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
part:ci Affects the GitHub workflow and other parts for running CI part:nox Affects the configuration of nox part:template Affects the cookiecutter template files type:enhancement New feature or enhancement visitble to users
Projects
None yet
Milestone
Untriaged
Development

No branches or pull requests
1 participant
@llucax