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

Establish standards for documentation #1025

Open
nrobinson2000 opened this issue Sep 18, 2019 · 0 comments
Open

Establish standards for documentation #1025

nrobinson2000 opened this issue Sep 18, 2019 · 0 comments

Comments

@nrobinson2000
Copy link
Contributor

nrobinson2000 commented Sep 18, 2019

Hey everyone,

Not sure if this has been brought up already, but I recently noticed a lot of inconsistencies throughout the documentation.

  • The style of descriptions for return values for library methods.
  • Many of the code snippets are using ```C++ instead of ```cpp.
  • Indentation style for code snippets.
  • Object construction style.

I think it would be a good idea to create a style guide for the documentation so that the formatting style for the descriptions of methods can be consistent throughout the documentation, improving readability and accessibility to information.

I recognize that reformatting the documentation will take lots of effort but I think that it is in everyone's best interest to improve the documentation however possible.

I recently opened a pull request that makes some of the changes listed above, but it is nowhere close to addressing the entire documentation: #1024

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

No branches or pull requests

1 participant