pyCGM icon indicating copy to clipboard operation
pyCGM copied to clipboard

Adding standards to documentation

Open khgaw opened this issue 4 years ago • 1 comments

Summary of PR:

This PR adds the coding standards to the documentation

image image

What issues does this PR close:

Documentation

What files were changed and what changes were made?

Community.rst - Add a community guidelines section of the documentation Standards.rst - Contains coding standards, math standards, and abbreviations index.rst - Add Community.rst

Does your PR (check all that applies):

  • [x] Add documentation
  • [x] Change/Remove documentation
  • [ ] Add tests
  • [ ] Change/Remove tests
  • [ ] Add code
  • [ ] Change/Remove code
  • [ ] Fix formatting

Are there any errors/relevant logs in your code?

No

How has this been tested?

Run sphinx

khgaw avatar Apr 29 '21 02:04 khgaw

This should probably be in the refactor, as the current code doesn't use the matrices and such

cadop avatar May 07 '21 20:05 cadop