search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Further document the lower-level API in readthedocs and the demo directory #39

Closed villaa closed 2 years ago

villaa commented 2 years ago

v1.1.1

I am submitting a documentation issue.

The file(s) in question is/are: the files within the readthedocs directory docs/ and the demo example-usecase/

The problem is in the following category/categories: Currently (v1.1.1) the functionality of the program involves only the executable realizeCascades so it is appropriate for this version to have that documented only. However, the library developed has more use cases and could be more fully documented, specifically these libraries included in realizeCascades.cpp

//library commands
#include "cascadeProd.h"
#include "lindhard.h"
#include "weisskopf.h"
#include "isotope_info.h"

Description of the problem: Each of the underlying library functions should be exposed to the public as part of the API and documented fully in readthedocs.

villaa commented 2 years ago

This was addressed by enhancing the Sphinx documentation prior to release v1.2.4