Format /Fopathname so it doesn't get separated #4415
Conversation
Browsers render **`/Fo`***`pathname`* as two separate strings which confuses those who want to quickly glance at the syntax and move on. "Remarks" section clearly says "Don't put a space between the /Fo option and the pathname argument".
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
1 similar comment
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
3 similar comments
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit dc9c452: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@corob-msft Can you review the proposed changes? When the changes are ready for publication, add a #label:"aq-pr-triaged" |
|
@snakecase : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
There was a problem hiding this comment.
@snakecase
I appreciate your initiative and commend you for looking out for your fellow docs users. Your intentions are good, but they've run into an issue we've argued about with the team in charge of our CSS styling for years. The title doesn't need to be changed, since the part in parentheses is the description of the option, not the description of the argument to the option. The syntax block, on the other hand, isn't supposed to look like it has a space between the option and the pathname. The only reason it does is because the CSS for code styling has some unnecessary horizontal padding, and we have to apply the bold code styling and the italicized code styling in separate sections. We've opted to stick with the standardized styling and live with the apparent space, making sure to comment that it isn't supposed to be there. It's an imperfect solution, but for consistency across the docs it's what we're sticking with for now. My apologies for not accepting your PR.
|
Closing as not consistent with our style. |
|
Sad that consistency (especially where it clearly works against the user) takes precedence over common sense. This PR was made only because a few people on my team have already lost some time trying to figure out why the command doesn't work and were really confused about documentation confirming their expectations of I propose to put the |
Browsers render
/Fopathnameas two separate strings which confuses those who want to quickly glance at the syntax and move on. "Remarks" section clearly says "Don't put a space between the /Fo option and the pathname argument".