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.

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

Elaborate on struct documentation #539

Open
1 task done
SouthEndMusic opened this issue Feb 3, 2025 · 0 comments
Open
1 task done

Elaborate on struct documentation #539

SouthEndMusic opened this issue Feb 3, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@SouthEndMusic
Copy link
Contributor

Wflow version checks

  • I have checked that the issue still exists on the latest versions of the docs on master here

Kind of issue

Docs are unclear

Location of the documentation

From my slides:

From the docstring of a struct I would like to be able to tell:

  • Why arrays have the size they have

  • What each element of an array corresponds to

  • Preferably also where the ordering of the data comes from

In general, the docstring should allow you to make a mental map of what this part of the model represents

Documentation problem

.

Suggested fix for documentation

.

@SouthEndMusic SouthEndMusic added the documentation Improvements or additions to documentation label Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant