Skip to content

Check the language, clarity and consistency of documentation #6

Description

@adbar

A short version of the documentation is available straight from Github (README.rst) while a more exhaustive one is present in the docs folder and online on htmldate.readthedocs.io

Several problems could arise:

  • Non-idiomatic use of English (not quite fluent or natural)
  • Unclear or incomplete descriptions
  • Code examples that don't work
  • Typos in explanations or code sections
  • Outdated sections

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions