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

doc: Expand and organize Decorate documentation #858

Merged
merged 2 commits into from Mar 10, 2022
Merged

Conversation

abhinav
Copy link
Collaborator

@abhinav abhinav commented Mar 9, 2022

This elaborates on the documentation for fx.Decorate with more examples,
and organizes it into two sections:

  • Decorator functions, enumerating the various signatures a decorator
    function can have
  • Decorator scope, explaining how decorator changes are scoped

Added demonstrative examples for everything.
In the future, we can turn some of these into example tests.

Refs GO-1254


Preview:
image

This elaborates on the documentation for fx.Decorate with more examples,
and organizes it into two sections:

- Decorator functions, enumerating the various signatures a decorator
  function can have
- Decorator scope, explaining how decorator changes are scoped

Added demonstrative examples for everything.
In the future, we can turn some of these into example tests.

Refs GO-1254
@codecov
Copy link

codecov bot commented Mar 9, 2022

Codecov Report

Merging #858 (6536516) into master (6bc0d21) will decrease coverage by 0.18%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #858      +/-   ##
==========================================
- Coverage   98.63%   98.45%   -0.19%     
==========================================
  Files          30       30              
  Lines        1100     1100              
==========================================
- Hits         1085     1083       -2     
- Misses         10       11       +1     
- Partials        5        6       +1     
Impacted Files Coverage Δ
decorate.go 100.00% <ø> (ø)
app.go 94.95% <0.00%> (-0.92%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6bc0d21...6536516. Read the comment docs.

@abhinav abhinav requested a review from sywhang March 9, 2022 23:13
@abhinav abhinav merged commit 65e6e7f into master Mar 10, 2022
@abhinav abhinav deleted the abg/decorator-doc branch March 10, 2022 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants