Create examples

[prakaa]

• Core functionality function docstrings should have, or be linked to examples

[nick-gorman]

Adding some specific suggestions to this issue. I think in both the Core functionality and API Reference documentation it would be good to have either examples (even if they are just simple ones) or links to examples where the class or functions is used.

[prakaa]

Thanks @nick-gorman. Agree the core functionality functions could have this. All of those functions have examples in the Quick Start section of the docs, so just a matter of linking the docstrings or other text to them.

As for the API Reference, I'm not sure I agree. It's a "high effort, low gain" thing because it mainly benefits devs rather than all users. And if you are a dev, the class-based structuring of functionality should make it easy to understand how things are used/structured (assuming that the names of functions and classes are appropriate).

For example, see compile_data:

NEMSEER/src/nemseer/nemseer.py

Line 122 in f4870b2

def compile_data(

:

1. Composed of instantiation of instances, then method calls
2. If you follow the method calls, you will find the underlying code and any refs to public and/or private funcs
3. All funcs, regardless of whether they are public or private, are documented