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

Adding standards to documentation #104

Draft
wants to merge 61 commits into
base: dev
Choose a base branch
from
Draft

Conversation

khgaw
Copy link
Contributor

@khgaw khgaw commented Apr 29, 2021

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):

  • Add documentation
  • 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 khgaw changed the base branch from dev-refactor-4x4s to dev April 29, 2021 22:21
@khgaw khgaw marked this pull request as draft May 4, 2021 20:24
@khgaw khgaw marked this pull request as ready for review May 7, 2021 18:53
@cadop
Copy link
Owner

cadop commented May 7, 2021

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

@khgaw khgaw marked this pull request as draft May 7, 2021 22:54
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

Successfully merging this pull request may close these issues.

2 participants