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.

Sign up for GitHub

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

Jump to bottom

Documentation #3

Open
broad-well opened this issue Apr 11, 2018 · 1 comment
Open

Documentation #3

broad-well opened this issue Apr 11, 2018 · 1 comment
Labels
standard Corresponds to the standards used throughout the project, such as documentation & design heuristics.

Comments

@broad-well
Copy link
Member

This issue is meant for the discussion of standard practices in documenting this project.

Possible methodologies and subtopics include:

  • JavaDoc
  • Pseudocode
  • Wiki content
  • In-line comments
@broad-well broad-well added the standard Corresponds to the standards used throughout the project, such as documentation & design heuristics. label Apr 11, 2018
@LakeYin
Copy link
Contributor

LakeYin commented Apr 11, 2018

Documentation should first be placed in the Drive with the standard template since it would be most convenient for when the Engineering Notebooks are assembled (and that is the most important use for documentation).

LakeYin added a commit that referenced this issue Oct 17, 2018
@LakeYin
Merge pull request #3 from Andover-Robotics/master
1c8d3af 
Merge all of the DogeCV 2018 stuff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
standard Corresponds to the standards used throughout the project, such as documentation & design heuristics.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@broad-well @LakeYin