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

Check the language, clarity and consistency of documentation #6

Open
adbar opened this issue Jan 3, 2020 · 2 comments
Open

Check the language, clarity and consistency of documentation #6

adbar opened this issue Jan 3, 2020 · 2 comments
Labels
good first issue Good for newcomers up for grabs Good for (first) contributors

Comments

@adbar
Copy link
Owner

adbar commented Jan 3, 2020

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
@adbar adbar added good first issue Good for newcomers up for grabs Good for (first) contributors labels Jan 3, 2020
@undefynedd
Copy link

Can I try this? (this is my first issue)

@adbar
Copy link
Owner Author

adbar commented Apr 26, 2021 via email

@adbar adbar pinned this issue Nov 1, 2021
@MSK1582 MSK1582 mentioned this issue Apr 3, 2022
Merged
@EkaterineSheshelidze EkaterineSheshelidze mentioned this issue Feb 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers up for grabs Good for (first) contributors
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@adbar @undefynedd