add more julia docstrings #607
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
visr
requested review from
SouthEndMusic and
Hofer-Julian
and removed request for
SouthEndMusic
Can you open an issue for this? |
Hofer-Julian
approved these changes
Sep 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started this off simply wanting to switch to Documenter.jl version 1.0 that recently got released. But what wasn't clear from #470 is that the DocumenterMarkdown backend we use is not actively maintained, meaning we are stuck for now on the old Documenter 0.27.
In any case this addresses a few Documenter 0.27 warnings about missing docstrings. And when I started adding docstrings I figured the key functions really need some docstrings. I also added some more convenient methods, e.g. extending
solve!from SciML on our Model, and addingmodel = Ribasim.Model(config)instead of only the more verbose BMI interface methodmodel = BMI.initialize(Ribasim.Model, config).