Indent option explanations using definition lists (:) #2755
Conversation
mtrmac
left a comment
mtrmac
left a comment
There was a problem hiding this comment.
https://github.com/containers/skopeo/blob/main/CONTRIBUTING.md#sign-your-prs please, we can’t really even look at PRs with unclear copyright status. Thanks!
Thanks for the reminder. I'll look into it later. |
Signed-off-by: herrenP <[email protected]>
herrenP
force-pushed
the
manpage-indent-fix
branch
from
22217a1 to
1c3712c
Compare
docs/skopeo-list-tags.1.md
Outdated
| **--creds** _username[:password]_ for accessing the registry. | ||
| **--creds** _username[:password]_ | ||
|
|
||
| : For accessing the registry |
There was a problem hiding this comment.
Now that this is not on one line, please use “Credentials for accessing the registry”. Similarly the --…creds and …registry-token (“Bearer token …”) options in skopeo-sync.
docs/skopeo.1.md
Outdated
|
|
||
| : An image _tag_ in a tar archive compliant with "Open Container Image Layout Specification" at _path_. | ||
|
|
||
| See [containers-transports(5)](https://github.com/containers/image/blob/main/docs/containers-transports.5.md) for details. |
There was a problem hiding this comment.
This applies to all of the transports, so it should not be indented as if it were related to only oci-archive:.
docs/skopeo-copy.1.md
Outdated
| - index-only: Copy only the index | ||
|
|
||
| The index-only option usually fails unless the referenced per-architecture images are already present in the destination, or the target registry supports sparse indexes. | ||
| The index-only option usually fails unless the referenced per-architecture images are already present in the destination, or the target registry supports sparse indexes. |
There was a problem hiding this comment.
Non-blocking: This seems to not be recognized as a part of the --multi-arch section. I don’t know whether that’s possible to cleanly fix — perhaps not easily, guessing https://github.com/cpuguy83/go-md2man/blob/061b6c7cbecd6752049221aa15b7a05160796698/md2man/roff.go#L155 seems to be a special case which doesn’t handle the nested list here.
There was a problem hiding this comment.
Non-blocking: This seems to not be recognized as a part of the
--multi-archsection. I don’t know whether that’s possible to cleanly fix — perhaps not easily, guessing https://github.com/cpuguy83/go-md2man/blob/061b6c7cbecd6752049221aa15b7a05160796698/md2man/roff.go#L155 seems to be a special case which doesn’t handle the nested list here.
Sorry for being late with the updates. I was in such a rush I forgot to add more details about my changes. Anyway, regarding the inline list, I think I worked around it by simply indenting the list.
Looks OK in my opinion. I hope you agree.
|
Other reviewers: highlighting
|
Signed-off-by: herrenP <[email protected]>
2 participants
This will render fine when generating man page files and also when viewed in vscode using "Markdown Preview Enhanced" extension. The built-in preview does not support definition lists. Also, when users are browsing project files in Github and view any of the .md files they will show a colon in front of each explanation unfortunately.