Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Add linting for "meta" documentation files (README.rst, etc.) #1530

Open
TibsAtWork opened this issue Nov 4, 2022 · 1 comment
Open

Add linting for "meta" documentation files (README.rst, etc.) #1530

TibsAtWork opened this issue Nov 4, 2022 · 1 comment
Labels
linting Changes to the vale setup we use for linting our docs website Related to the website or other implementation

Comments

@TibsAtWork
Copy link
Contributor

We don't apply Vale linting to our "meta" documentation files, specifically:

  • CONTRIBUTING.rst
  • README.rst
  • REVIEWING.rst
  • .github/vale/README.rst

I believe it would be a good idea to do so, as they are still part of the visible presence of this repository, even if only on GitHub.

Solution: add $(SOURCEDIR)/*.rst and $(SOURCEDIR)/.github/vale/README.rst to the targets for vale in the Makefile rule for spell. Note that this would mean we no longer need the explicit case for $(SOURCEDIR)/index.rst.

(It's quite likely Vale will pick up some errors in those files - those should be fixed in the same PR)

@TibsAtWork TibsAtWork added linting Changes to the vale setup we use for linting our docs website Related to the website or other implementation labels Nov 4, 2022
@lornajane lornajane changed the title We don't lint our "meta" documentation files (README.rst, etc.) Add linting for "meta" documentation files (README.rst, etc.) Dec 8, 2022
@lornajane
Copy link
Contributor

Updated the title to make it clear what the issue is asking for, rather than what's not there. Hope this makes sense

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
linting Changes to the vale setup we use for linting our docs website Related to the website or other implementation
Projects
None yet
Development

No branches or pull requests

2 participants