Skip to content

Lint documentation writing style using Vale #237

@llucax

Description

@llucax

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:ciAffects the GitHub workflow and other parts for running CIpart:noxAffects the configuration of noxpart:templateAffects the cookiecutter template filestype:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions