Skip to content
This repository has been archived by the owner on Mar 14, 2021. It is now read-only.

DOC: models/state.jl is mostly undocumented #40

Open
AlexS12 opened this issue Jul 30, 2019 · 0 comments
Open

DOC: models/state.jl is mostly undocumented #40

AlexS12 opened this issue Jul 30, 2019 · 0 comments
Labels
doc related to documentation

Comments

@AlexS12
Copy link
Owner

AlexS12 commented Jul 30, 2019

Current situation
models/state.jl is mostly undocumented

Solution proposal
Generate docstring documentation for constructors (at least).
Is also desirable to include getters.
It would be convenient to have an entry in documentation describing the objective of the State struct (serving as an interface between different dynamic models and the simulator).
@AlexS12 AlexS12 added the doc related to documentation label Jul 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
doc related to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@AlexS12