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

Refine explanations and improve formatting in README.md #115

Merged
merged 3 commits into from
Feb 8, 2024

Conversation

derskythe
Copy link
Contributor

@derskythe derskythe commented Feb 6, 2024

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:

  • Added missing code blocks
  • Changing the format of code examples is was neccessary
  • Highlighting variable names and macro names in text
  • Refining links to section
  • Adjusting the indenting of API documentation listings for better readability

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.
Copy link
Owner

@P-p-H-d P-p-H-d left a 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 :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@P-p-H-d P-p-H-d self-assigned this Feb 7, 2024
Copy link
Owner

@P-p-H-d P-p-H-d left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@derskythe derskythe requested a review from P-p-H-d February 8, 2024 11:32
@P-p-H-d P-p-H-d merged commit cd37efc into P-p-H-d:master Feb 8, 2024
12 checks passed
@derskythe derskythe deleted the feat-styled-readme branch February 11, 2024 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants