sst-elements
sst-elements copied to clipboard
sstsimulator
documentation example local to the source code
Example of documentation local to the directory.
Content is from https://github.com/sstsimulator/sst-elements/issues/1799
Status Flag 'Pre-Test Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging NO INSPECTION HAS BEEN PERFORMED ON THIS PULL REQUEST! - This PR must be inspected by setting label 'AT: PRE-TEST INSPECTED'.
@feldergast @gvoskuilen We discussed in a meeting ~2 weeks ago a preference to not have local documentation and instead stick to
- public code documentation in Doxygen and
- "fully formalized" code and design documentation in http://sst-simulator.org/sst-docs/.
What do you think? Both the website and this "local" documentation have a roughly equivalent risk of being out-of-date relative to the code, and putting this in Doxygen is better in that regard. Injecting Doxygen into sst-docs, which would be more readable, might not be easy.
@berquist - @feldergast explained to me in June that README files in the git repo aren't visible to users of SST who don't read source.
Therefore @feldergast is enabling an extended --help
I asked @feldergast whether we could put a README in the respective source directories that say "look at the respective extended --help"? @feldergast said yes to that.
Status Flag 'Pre-Test Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging NO INSPECTION HAS BEEN PERFORMED ON THIS PULL REQUEST! - This PR must be inspected by setting label 'AT: PRE-TEST INSPECTED'.