enforce rules on code blocks style in docs #11178
Merged
Conversation
This file contains 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
zeke
reviewed
Nov 20, 2017
| @@ -18,7 +18,9 @@ See also [V8 Development](v8-development.md) | |||
| It is possible to debug Chromium with Electron by passing | |||
| `--build_debug_libcc` to the bootstrap script: | |||
|
|
|||
| $ ./script/bootstrap.py -d --build_debug_libcc | |||
| ```bash | |||
There was a problem hiding this comment.
Any particular reason some of these are bash and some are sh? We should probably just pick one. My vote would be sh because it's more generic but still always accurate.
There was a problem hiding this comment.
We have both bash and sh scattered all over the docs; I think if we were to fix them, we should open up another PR for it. Currently, the designated language for each code block isn't actually taken into account how it's rendered.
There was a problem hiding this comment.
+1 on preferring sh over bash in documentation AFAIK we're not using any bash-only extensions and any variant, e.g. dash, would also work
+1 on deferring the s/bash/sh/ changes to a followup patch
|
Getting a ci error only on jenkins machine 🤔 |
|
🔍 🐞 So @MarshallOfSound and I found a bug in the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds two rules to enforce proper code block styles (i.e. fenced with ```, and have a language specified per block), and fixes the resulting lint errors in our current docs. This will resolve electron/electronjs.org-old#868 where improper code blocks are not being styled on the website.