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.

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

[DOCS FIX] Increase documentation readability #21

Open
lucasstarsz opened this issue Feb 27, 2021 · 1 comment
Open

[DOCS FIX] Increase documentation readability #21

lucasstarsz opened this issue Feb 27, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@lucasstarsz
Copy link
Owner

The Outdated/Incorrect Information

The overall documentation content is confusingly worded and hard to follow from a beginner's perspective.

Suggestions

Run your documentation through a grammar checker. While the content of the documentation is good, even great, the wording obfuscates just how good it is entirely.

image
This is a great example of what I'm talking about. The beginning documentation makes sense -- the method is important because it initializes the instance for use.
However, in the second sentence of the About section...

This method provides the option of omitting specifying

Can you expect anyone that isn't an English major to comprehend that the first time they read it? (I'm exaggerating, yes, but just to get the point across.)

I really like this documentation, but it needs to be easier to read. I completely understand that your repo is in its incubation phase (it's not even reached v0.1 yet -- this is incredible work so far), but documentation is one of your biggest selling points. If you want that to be upheld, you'll need to keep working on it.

@lucasstarsz lucasstarsz added the documentation Improvements or additions to documentation label Feb 27, 2021
@lucasstarsz lucasstarsz self-assigned this Feb 27, 2021
@lucasstarsz lucasstarsz added the help wanted Extra attention is needed label Feb 28, 2021
@lucasstarsz
Copy link
Owner Author

For now, I'll be pushing this back until 0.2. Once 0.1 is done, I'll re-open this issue.

@lucasstarsz lucasstarsz reopened this Feb 28, 2021
@lucasstarsz lucasstarsz removed the help wanted Extra attention is needed label Feb 28, 2021
@lucasstarsz lucasstarsz added this to the 0.2.0 milestone Feb 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant