Documentation needed #4
Description
So far we have relied largely on demonstrative notebooks
at https://github.com/rsvp/fecon235
The source code here at fecon236 is designed to be more
explicit than casual usage, so if you have experience in
setting up a nice documentation framework, please
kindly volunteer.
The current "docs" need a complete redo, one that starts from fresh eyes.
Nobody peeks at the source code unless there is something which
solves their problem or extends their research interest.
As an analogy, Unix-style man pages are really dry,
but the usage examples are most useful in practice.
That's what fecon235 notebooks were intended to do informally,
but as the research topics got more specialized,
formalization of the structure for clarity became necessary,
hence the refactoring into fecon236.
As an example, forecast() used to be called directly,
but now we prefer fe.hw.forecast(). The user may not know
that fe is shorthand for fecon236 (not fecon235), and
that hw is an alias for the holtwinters.py module which
is physically located implicitly under the tsa directory
for time-series analysis.
This is the sort of thing which needs documentation
which should be a skilled blend of unit-based and
integrative explanations.
Let's us know if you would like to join a MathSci team.
Please discuss further at https://gitter.im/MathSci/fecon236