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

Fix minor issues in documentation #24

Merged
merged 2 commits into from
May 15, 2022

Conversation

clint-white
Copy link
Contributor

Here are a few cleanups to the documentation, mostly the formatting not the substance:

  • Update link to the Python documentation to the latest 3.x version instead of 3.5.
  • Add missing markdown inline code formatting and links to other documentation as appropriate.
  • Fix typos, add missing periods to the ends of sentences.
  • Regenerate REAMDME.md with cargo-readme.

Note that the documentation is inconsistent in how it refers to its primary type, sometimes using Counter and sometimes "counter". That's probably fine, the standard library often does the same thing (Vec and "vector", etc.). This PR does not attempt to standardize to one or the other way of refering to it. However, where the documentation used "Counter" with a captial C but no inline code formatting, we have added the markdown formatting. If you would like to decide on a standard way to refer to counters and make the use consistent throughout the documentation, I would be happy to ammend this PR with any necessary changes.

- Update link to the Python documentation to the latest 3.x version
  instead of 3.5.
- Add missing markdown inline code formatting and links to other
  documentation as appropriate.
- Fix typos, add missing periods to the ends of sentences.
- Regenerate `REAMDME.md` with
  [cargo-readme](https://github.com/livioribeiro/cargo-readme).
Copy link
Owner

@coriolinus coriolinus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do clean up the merge conflict, but the changes look good.

@coriolinus
Copy link
Owner

I don't intend to impose a standard way of referring to the type within the documentation; to me, counter (lowercase) is a somewhat more abstract term which would cover alternate implementations, and Counter (uppercase) refers only to this implementation.

@clint-white
Copy link
Contributor Author

Ok, that makes good sense on the use of counter as well as Counter.

I resolved the merge conflict.

@coriolinus
Copy link
Owner

Thanks again!

@coriolinus coriolinus merged commit f607820 into coriolinus:master May 15, 2022
@clint-white clint-white deleted the cleanup-documentation branch May 15, 2022 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants