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

Improve all inline tooltip documentation (doc comments), include exceptions info and all parameter info #136

Merged
merged 3 commits into from
Oct 30, 2023

Conversation

abelbraaksma
Copy link
Member

@abelbraaksma abelbraaksma commented Dec 19, 2022

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 ArgumentNullException to be thrown. Tedious work, but it must be done ;). Keeping it up-to-date afterwards should be easier.

@abelbraaksma abelbraaksma force-pushed the improve-doc-comments branch from 96a60ab to 2ad4c50 Compare June 5, 2023 14:05
@abelbraaksma abelbraaksma added documentation Improvements or additions to documentation cleanup labels Oct 29, 2023
@abelbraaksma abelbraaksma force-pushed the improve-doc-comments branch 2 times, most recently from 722063f to f8f156b Compare October 30, 2023 02:07
@abelbraaksma
Copy link
Member Author

abelbraaksma commented Oct 30, 2023

Finally, this is done. All exception information is now in the tooltips, and the limited ability that F# gives us for some syntax coloring in the tooltips is used for better recognizability.

Example:
image

@abelbraaksma
Copy link
Member Author

abelbraaksma commented Oct 30, 2023

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 static member next, I am going to move these in. However, ping me here if you still want to re-review this. Keep in mind that I've been seeking parity with seq in F# where applicable. A lot of wording is borrowed from there.

@abelbraaksma abelbraaksma merged commit 0270194 into main Oct 30, 2023
6 checks passed
@abelbraaksma abelbraaksma deleted the improve-doc-comments branch October 30, 2023 12:16
@bartelink
Copy link
Member

Please don't wait for me at any time - am fine with doing chaser reviews
Good point re aligning with Seq - if not already prominently mentioned, goot to have that high p the README.md
Though not having where is fine with me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants