Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add list of variables to documentation #36

Open
stefan-voelk opened this issue Nov 12, 2024 · 0 comments
Open

Add list of variables to documentation #36

stefan-voelk opened this issue Nov 12, 2024 · 0 comments
Assignees
@stefan-voelk
Labels
good first issue Good for newcomers module: core Related to the core module type: docs Improvements or additions to documentation

Comments

@stefan-voelk
Copy link
Collaborator

Add list of

  • (most relevant) variable names used within the program
  • description of variables
  • where in the program is variable used
  • unit of variable if applicable
  • input / other variables needed to calculate variable if applicable
@stefan-voelk stefan-voelk added type: docs Improvements or additions to documentation good first issue Good for newcomers module: core Related to the core module labels Nov 12, 2024
@stefan-voelk stefan-voelk self-assigned this Nov 12, 2024
@liammegill liammegill modified the milestone: v1.0.0 Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stefan-voelk stefan-voelk

Labels
good first issue Good for newcomers module: core Related to the core module type: docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@liammegill @stefan-voelk