docs: move flag examples to right section#6051
Merged
thaJeztah merged 1 commit intodocker:masterfrom May 6, 2025
Merged
Conversation
When generating our docs, flag-descriptions are currently expected to be under the "examples" section for them to be linked correctly. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6051 +/- ##
=======================================
Coverage 58.99% 58.99%
=======================================
Files 358 358
Lines 30004 30004
=======================================
Hits 17700 17700
Misses 11323 11323
Partials 981 981 🚀 New features to boost your workflow:
|
Benehiko
approved these changes
May 6, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
When generating our docs, flag-descriptions are currently expected to be under the "examples" section for them to be linked correctly.
Currently; the docs at https://docs.docker.com/reference/cli/docker/inspect/#options doesn't link the flags;
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)