-
Notifications
You must be signed in to change notification settings - Fork 80
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
Refine explanations and improve formatting in README.md #115
Conversation
Several corrections and readability enhancements were applied to the README.md file. This includes fixing typos, changing the format of code examples, refining links to sections, and adjusting the indenting of API documentation listings for better readability. General explanations and instructions about the API usage and the constructor and destructor behavior were also improved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for your huge rework on the documentation!
I performed a review of it and find (few) issues in it I have listed below.
By reading the patch I also found some errors in the original documentation :)
Corrections were made according PR P-p-H-d#115
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your quick taken into account of my remarks.
I have detected another minor issues.
Hi, Thanks for the library.
For my part, I would like to offer updated documentation.
In my opinion, in this form it is much easier to read and easier to navigate.
What is done: