WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Check Correct Spelling in Docstrings #1007

@niccokunzmann

Description

@niccokunzmann

The Vale spellchecker helps us already with writing documentation that is not misspelled.

It is possible to configure Vale to also check the Python Docstrings. They are part of the documentation too. Actually a huge part.

To close this issue:

  • configure Vale to run on the Python documentation
  • It is not needed to run on test code or comments
  • create a pull request and resolve the spelling mistakes
  • possible extend the accept list and deny list of words

See also:

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions