doc: add minimal documentation for solving system and retrieving results #16
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
This can be inferred from tests/*.ml, but it is better to have some minimal documentation on what the parameters mean. Especially that solving the system returns the same type that was given as input (i.e. the environment is mutable). Signed-off-by: Edwin Török <edwin@etorok.net>
hra687261
approved these changes
Mar 16, 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.
This can be inferred from tests/*.ml, but it is better to have some minimal documentation on what the parameters mean.
Especially that solving the system returns the same type that was given as input (i.e. the environment is mutable).
This is my attempt to improve the documentation slightly based on what I could infer from the tests, please correct me if it is wrong or note entirely accurate.