-
Notifications
You must be signed in to change notification settings - Fork 366
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
Docs improvements #2100
Docs improvements #2100
Conversation
Codecov ReportPatch and project coverage have no change.
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## main #2100 +/- ##
=======================================
Coverage 91.15% 91.15%
=======================================
Files 101 101
Lines 48866 48866
Branches 48866 48866
=======================================
Hits 44544 44544
Misses 4322 4322
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for having a go at this!
I think generally we want to tick or link all references to objects in doc comments. However, for the sake of readability it should generally be enough to link the first occurrence in a paragraph and only tick the rest of the references (there are of course exceptions to this, so def. feel free to link when you think it's needed).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
e84874e
to
060a399
Compare
Addressed all review comments and moved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
One optional thing you could tackle while you're here is to ensure that any (C-not exported)
lines come after a blank line, as these comments are not meant for humans and they'll end up in the module-level docs otherwise. One example to be fixed would be PaymentId
, but there are others.
I think a PR focused on that would be better. I've created #2105 |
SGTM, even though it might introduce some additional git noise. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, your cleanups turned up a bunch of places where the docs are just downright ancient and need updating :)
@TheBlueMatt Please double check the changes |
I think it's okay now 🤞 |
@tnull done |
I was looking at the documentation and found some missing references. Doing that I found minor "bugs" (wrong references). See below for my double check comments.
Please note this change isn't exhaustive, there are still many places where similar changes can be made.