Clarify documentation on fx.Annotate #926
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
Some people are getting confused why fx.Annotate doesn't work with fx.In or fx.Out struct and may think this is a bug. Clarify in the documentation that this is not meant to be used with fx.In or fx.Out structs - it replaces their usages.
Codecov Report
@@ Coverage Diff @@
## master #926 +/- ##
=======================================
Coverage 98.72% 98.72%
=======================================
Files 30 30
Lines 1332 1332
=======================================
Hits 1315 1315
Misses 11 11
Partials 6 6
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
abhinav
approved these changes
Aug 19, 2022
sywhang
added a commit
to sywhang/fx
that referenced
this pull request
Oct 11, 2022
* Clarify documentation on fx.Annotate Some people are getting confused why fx.Annotate doesn't work with fx.In or fx.Out struct and may think this is a bug. Clarify in the documentation that this is not meant to be used with fx.In or fx.Out structs - it replaces their usages. * some formatting fix
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.
Some people are getting confused why fx.Annotate doesn't work with
fx.In or fx.Out struct and may think this is a bug.
Clarify in the documentation that this is not meant to be used with
fx.In or fx.Out structs - it replaces their usages.