app.go: Take a pass over the godoc #1162
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
The godocs for most of the public API in app.go hasn't been touched in a while. I took a quick pass over it to adjust it better to current recommendations and best practices. This also makes more use of Go's `[..]` linking. One notable change: Instead of Options, logical groups of options are now recomended via Module.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1162 +/- ##
=======================================
Coverage 98.79% 98.79%
=======================================
Files 30 30
Lines 3061 3061
=======================================
Hits 3024 3024
Misses 30 30
Partials 7 7 ☔ View full report in Codecov by Sentry. |
JacobOaks
approved these changes
Feb 20, 2024
annotated.go
Outdated
| @@ -109,8 +111,9 @@ var ( | |||
| } | |||
| ) | |||
|
|
|||
| // Annotation can be passed to Annotate(f interface{}, anns ...Annotation) | |||
| // for annotating the parameter and result types of a function. | |||
| // Annotation decorates a target for [Annotate]. | |||
There was a problem hiding this comment.
This overloads "decorate" a little bit. Consider a different word choice, or just merging with the following sentence.
sywhang
approved these changes
Feb 20, 2024
Co-authored-by: Jacob Oaks <jacoboaks.8@gmail.com>
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.
The godocs for most of the public API in app.go hasn't been touched in a
while.
I took a quick pass over it to adjust it better to current
recommendations and best practices.
This also makes more use of Go's
[..]linking.One notable change: Instead of Options, logical groups of options are
now recomended via Module.