Improve all inline tooltip documentation (doc comments), include exceptions info and all parameter info#136
Merged
abelbraaksma merged 3 commits intomainfrom Oct 30, 2023
Merged
Conversation
96a60ab to
2ad4c50
Compare
…on. Improve most descriptions.
722063f to
f8f156b
Compare
Member
Author
f8f156b to
a3edd40
Compare
…t set of functions
a3edd40 to
e206af5
Compare
Member
Author
|
The comments were actually from #183, which accidentally included these document updates as well. @bartelink Since this causes quite a bit of potential merge issues, esp if I go for |
Member
|
Please don't wait for me at any time - am fine with doing chaser reviews |
Merged
This file contains hidden or 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
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.

As in the title. Esp. now that we've added all the proper null-checks in #127, we should clarify for each function what input would cause
ArgumentNullExceptionto be thrown. Tedious work, but it must be done ;). Keeping it up-to-date afterwards should be easier.