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
ipcs: fix POSIX page; linux/ipcs, lsipc: add pages #12553
Conversation
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment was marked as outdated.
This comment was marked as outdated.
This comment has been minimized.
This comment has been minimized.
This comment was marked as resolved.
This comment was marked as resolved.
Hello! I've noticed something unusual when checking this PR:
Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits. |
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.
LGTM, Thanks for your contribution.
See #12354 (comment) details on the "See command1 for function1, command2 for function2" syntax proposal.
We should probably document this in the style guide too.
Yeah, I was waiting for some more opinions because this replaces the already documented "See also: |
Hello! I've noticed something unusual when checking this PR:
Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits. |
ef71c49
to
3780dce
Compare
Hello! I've noticed something unusual when checking this PR:
Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits. |
@kbdharun @sebastiaanspeck @acuteenvy on second thought, I think the "See Introducing a different syntax for suggested pages can be worse for mixing suggestions with and without a description. Since @acuteenvy sees the ponctuation as the biggest problem, how about going with:
|
What do you mean? There are no suggestions without a description in this PR. |
I mean, if we want to standardize the syntax you suggested in the style guide, there may be sistuations like this, did you get the |
Suggesting two pages with a description and one without looks weird to me nevertheless. I'd personally avoid this and either describe all suggestions or none. |
I personally disagree, the "See also" line is so useful for suggest similar tools for both very similar tools, complementary tools or just similar to some extent, see #12582, where I connected several tools that belongs to a same category. In pages that have like 3 to 5 suggestions, it may make sense to add a description for just the complementary one, for example, and don't add descriptions to very similar tools. |
I agree with @acuteenvy here, having multiple descriptions referencing multiple pages/function looks weird to me as well. Just referencing the names of the multiple pages in See also line (i.e.
In this suggestion, the comma used can confuse users i.e. is command2 and command3 used for function3 or is command3 only used for function3. |
Yeah, I agree on that, my intention was to describe just the latter command. @acuteenvy @kbdharun @sebastiaanspeck So I have 3 syntax proposals:
PS: I accidentally posted this comment on the another related PR, so I'm deleting this comment in the another PR. |
Or 3. - as it currently is in this PR
|
Oh, I've accidentaly erased the other proposal, so:
Edit: Personally, I prefer the other 3 because of the eventual client usage I've talked about in my previous comment. What do you guys prefer? Or do you have a better idea? |
@acuteenvy @kbdharun @sebastiaanspeck any opinion on these 4 proposals or a new proposal? |
Just now stumbled upon this ping while checking the notifications, IMO the 3rd one that we currently use LGTM. Using semi-colons in the 1st and 2nd proposals looks odd compared to using commas. The fourth proposal changes the syntax so the 2nd "see also" line won't be rendered differently by clients implementing styling for this. |
Co-authored-by: K.B.Dharun Krishna <[email protected]>
Hello! I've noticed something unusual when checking this PR:
Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits. |
Co-authored-by: K.B.Dharun Krishna <[email protected]>
Co-authored-by: K.B.Dharun Krishna <[email protected]>
common
,linux
,osx
,windows
,sunos
,android
, etc.See #12354 (comment) details on the "See
command1
for function1,command2
for function2" syntax proposal.