docs: add some notes about best practices #51
Merged
Conversation
This file contains hidden or 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
muir
commented
Jan 14, 2023
sharnoff
reviewed
Jan 14, 2023
There was a problem hiding this comment.
Generally structure of this change looks good. I think doc.go is missing a kind of quick, friendly & familiar example to set the ball rolling — something mostly contrived, but not quite as bad as "here's three string types". Maybe something with strconv.ParseInt() and/or Context?
I'd imagine something like:
- Explain generally what dependency injection does (done)
- Say something like "here's a simple example that does XYZ" - it shoud be <= 15 lines, but commented to explain how data is passed from one function to another.
- From there, start talking about injectors, providers, etc — readers should have a basic idea to build from, first. And as you introduce concepts, you can link back to the first example — like "ABC was an example of a DEF" or "DEFs are more flexible than just ABC"
Co-authored-by: sharnoff <29154784+sharnoff@users.noreply.github.com>
Codecov ReportBase: 83.70% // Head: 83.70% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
=======================================
Coverage 83.70% 83.70%
=======================================
Files 21 21
Lines 2989 2989
=======================================
Hits 2502 2502
Misses 317 317
Partials 170 170 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 at Codecov. |
Co-authored-by: sharnoff <29154784+sharnoff@users.noreply.github.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.
No description provided.