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

Adding content in Python API reference #1571

Closed
Tracked by #1623
Jingru923 opened this issue Jun 21, 2024 · 1 comment · Fixed by #1643
Closed
Tracked by #1623

Adding content in Python API reference #1571

Jingru923 opened this issue Jun 21, 2024 · 1 comment · Fixed by #1643
Assignees
Labels
documentation Improvements or additions to documentation python Relates to one of the Ribasim python packages

Comments

@Jingru923
Copy link
Contributor

Jingru923 commented Jun 21, 2024

As the outcome of #1439 we have now a frame for our Python API reference, but at the moment not a lot of content.

The API reference is generated by quartodoc, where it will grasp docstrings in the code and display them in the documentation.

To add more content in the API reference, one can simply add docstring that explaining the functionality of the attribute in Model() class.

@Jingru923 Jingru923 converted this from a draft issue Jun 21, 2024
@Jingru923 Jingru923 added documentation Improvements or additions to documentation python Relates to one of the Ribasim python packages labels Jun 21, 2024
@Jingru923 Jingru923 moved this from Sprint backlog to What's next in Ribasim Jun 24, 2024
@evetion
Copy link
Member

evetion commented Jul 4, 2024

Scope: I think all the classes/methods that we provide in our tutorials should have docstrings.

@evetion evetion added the v1.0 label Jul 4, 2024
@visr visr mentioned this issue Jul 15, 2024
7 tasks
@Jingru923 Jingru923 moved this from What's next to Sprint backlog in Ribasim Jul 15, 2024
@Jingru923 Jingru923 moved this from Sprint backlog to 🏗 In progress in Ribasim Jul 18, 2024
@SouthEndMusic SouthEndMusic moved this from 🏗 In progress to 👀 In review in Ribasim Jul 22, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Ribasim Jul 23, 2024
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 python Relates to one of the Ribasim python packages
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants