-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
lsblk: add page #597
lsblk: add page #597
Conversation
You managed to upset Travis a bit, check out the details to find out where the linter got annoyed. The html complaints are erroneous, you can ignore those. On a more serious note, while I see some really good examples listed the page is simply way too long. In our contributing guidelines we suggest 5-6 examples, though we've gone a bit over that for large commands. This is not such a one I'm afraid. In fact, I see you listed more examples than my MAN page list usages, like the exotic Our goal with tldr pages is to have common usage patterns quickly accessible, without having to skim through too much. Pages like that would deter users, and while they're really good for extensive examples, they're pretty much what tldr tries to solve. There's some great stuff in here, so I suggest you think over what commands would be used most often, or at least by newbies. For example, I've only ever used the I'd be more than happy to review a slimmed-down version of this file. |
@rubenvereecken Ok 👍 |
@rubenvereecken is it ok now 😄 |
@@ -0,0 +1,27 @@ | |||
# lsblk | |||
|
|||
> lsblk lists information about all available or the specified storage devices. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we shorten this into "lists information about storage devices"? That sounds snappier while still in essence containing the above.
@gautamkrishnar thanks for swiftly trimming it down. Let's just go over the inline comments and all should be good :). |
@rubenvereecken done 👍 . |
We don't have guidelines for line formatting yet (capitalization/end with punctuation) but you're being inconsistent there with 2/6 having no periods at the end. If you can just patch those up you have my heartfelt 👍 |
0ba72b1
to
f0d69c3
Compare
@rubenvereecken squashed |
f0d69c3
to
35616d7
Compare
Great, thanks. We'll fix the syntax with the formatter. Thanks for the page! |
lsblk man