Remove hashes in front of commands#10219
Merged
Merged
Conversation
On the website they look like commented lines
Member
Then the CSS needs to be adjusted. |
Contributor
Author
|
It makes sense to display them as comments for bash scripts. They are actually comments |
frenck
approved these changes
Aug 25, 2019
Member
frenck
left a comment
frenck
left a comment
There was a problem hiding this comment.
Thanks, @Derkades! 👍
@fabaff These are being removed for many reasons.
- Copy/paste made easy.
- Conflicts with Markdown rules MD014.
- Is requested not to in our own developer docs.
- Highlighting issues, as
#in shell scripts are used as comments. - If
$&#root/user? TBH if that is the indicator, the documentation around it is incomplete and unclear. Most of our user base will not know the difference.
probot-home-assistant
Bot
removed
the
ready-for-review
Contributor
|
@fabaff Looks like our own documentation standards on this were updated by Frenck last month - it's caught quite a few of us out having the standard reversed ;) |
Member
|
@DubhAd As explained to you in the other PR as well, this has been applied by me & @klaasnicolaas for quite some time now, and have been actively removing it from many places way longer already. |
StephenWetzel
pushed a commit
to StephenWetzel/home-assistant.io
that referenced
this pull request
Aug 26, 2019
On the website they look like commented lines
jjlawren
pushed a commit
to jjlawren/home-assistant.io
that referenced
this pull request
Aug 26, 2019
On the website they look like commented lines
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
5 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.
On the website they look like commented lines:
