-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
Adding "examples" section for real-life usages #1953
Comments
Good point. There is already an example for each function in the Doxygen documentation. I am a bit worried that adding another source of documentation may be confusing. |
I think we can add these source into github wiki. |
The Wiki is intentionally switched off for this project as it would be another source of information which could be even more confusing. |
Whoops. I totally missed docs/examples directory. So this is where all example codes for the documentation is located. Regarding the examples, I think there are two points to consider:
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Currently README provides a minimal set of examples about how the library can be used. While It covers most of basic functionality, some users occasionally have trouble in using the library in more complex situations. Here are some recent examples: #1930, #1874, #1892, #1931.
A user can eventually figure it out by reading the documentation, but having some examples for various use-cases which are closer to real-life scenarios can be very helpful in using the library "correctly" and can also reduce the number of opened issues related to usage problems.
Any thoughts or suggestions on adding such section to the library?
The text was updated successfully, but these errors were encountered: