Added isis class documentation guidelines #72
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acpaquette
reviewed
May 13, 2024
| class XmlHandler : public XmlStackedHandler { | ||
| ``` | ||
|
|
||
| All dates need to be filled out the way they are in the examples above (YYYY-MM-DD). Sometimes you will see dates in this format: 2012-??-???? or ????-??-??. Do not do this. Also, do not put any dashes or other symbols between the date and the name of the programmer. |
There was a problem hiding this comment.
I remember when we transitioned to github this was something that we decided we weren't going to do anymore. Do we still want to include it here? @Kelvinrr thoughts?
There was a problem hiding this comment.
Honestly I'm not a fan of this doc page in general. It seems like this should a be one-line blurb somewhere in a "code style" or "standards" doc rather than a separate page. I removed the outdated references, but we might consider just closing this PR rather than merging.
There was a problem hiding this comment.
yeah we ended the history comments completely.
+1 to what Austin said, this should go under ISIS contributing docs on the repo. Any tutorial about contributing here should just link to it.
…oper_references_class_documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #19
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words: