cli/command: fix deprecation comments for Stream types #4152
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
These were deprecated in 6c400a9 (docker 19.03), but the "Deprecated:" comments were missing a newline before them. While most IDEs will detect such comments as "deprecated", pkg.go.dev and linters will ignore them, which may result in users not being aware of them being deprecated. This patch; - Fixes the "Deprecated:" comments. - Changes the var aliases to functions, which is slightly more boilerplating, but makes sure the functions are documented as "function", instead of shown in the "variables" section on pkg.go.dev. - Adds some punctuation and adds "doc links", which allows readers to navigate to related content on pkg.go.dev. Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
added
impact/deprecation
status/2-code-review
process/cherry-pick
kind/bugfix
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4152 +/- ##
==========================================
- Coverage 59.03% 59.02% -0.01%
==========================================
Files 287 288 +1
Lines 24767 24771 +4
==========================================
Hits 14620 14620
- Misses 9264 9268 +4
Partials 883 883 |
This was referenced Apr 1, 2023
vvoland
approved these changes
Apr 3, 2023
Member
Author
|
Thx! Let me bring this one in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
These were deprecated in 6c400a9 (docker 19.03), but the "Deprecated:" comments were missing a newline before them.
While most IDEs will detect such comments as "deprecated", pkg.go.dev and linters will ignore them, which may result in users not being aware of them being deprecated.
This patch;
Before this patch:
https://pkg.go.dev/github.com/docker/[email protected]+incompatible/cli/command#InStream
With this patch:
- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)