Formats code blocks for better syntax highlighting [ci skip] #40079
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
| @@ -461,7 +461,7 @@ Database Views | |||
|
|
|||
| Imagine you need to work with a legacy database containing the following table: | |||
|
|
|||
| ``` | |||
| ```sql | |||
There was a problem hiding this comment.
Not sure if this really benefits from highlighting...?
| @@ -678,7 +678,7 @@ SELECT viewable_by, locked FROM clients | |||
|
|
|||
| Be careful because this also means you're initializing a model object with only the fields that you've selected. If you attempt to access a field that is not in the initialized record you'll receive: | |||
|
|
|||
| ``` | |||
| ```ruby | |||
There was a problem hiding this comment.
This is technically not Ruby.
| @@ -1236,13 +1236,13 @@ The code evaluating `Hotel::Image` needs to make sure | |||
|
|
|||
| In these cases the interpreter issues a warning though: | |||
|
|
|||
| ``` | |||
| ```ruby | |||
There was a problem hiding this comment.
This is not really Ruby.
| warning: toplevel constant Image referenced by Hotel::Image | ||
| ``` | ||
|
|
||
| This surprising constant resolution can be observed with any qualifying class: | ||
|
|
||
| ``` | ||
| ```ruby |
There was a problem hiding this comment.
Because of the mixed content, I think the highlighting here detracts more than it adds.
| @@ -208,7 +208,7 @@ Adding extra logging like this makes it easy to search for unexpected or unusual | |||
|
|
|||
| When looking at database query output in logs, it may not be immediately clear why multiple database queries are triggered when a single method is called: | |||
|
|
|||
| ``` | |||
| ```ruby | |||
There was a problem hiding this comment.
Because of the mixed content, I think the highlighting here detracts more than it adds.
| @@ -219,7 +219,7 @@ irb(main):001:0> Article.pamplemousse | |||
|
|
|||
| After running `ActiveRecord::Base.verbose_query_logs = true` in the `bin/rails console` session to enable verbose query logs and running the method again, it becomes obvious what single line of code is generating all these discrete database calls: | |||
|
|
|||
| ``` | |||
| ```ruby | |||
There was a problem hiding this comment.
Because of the mixed content, I think the highlighting here detracts more than it adds.
guides/source/security.md
Outdated
| @@ -666,7 +666,7 @@ Project.where("name = '#{params[:name]}'") | |||
|
|
|||
| And now let's inject another query using the UNION statement: | |||
|
|
|||
| ``` | |||
| ```sql | |||
There was a problem hiding this comment.
This technically isn't valid SQL by itself, so the highlighting doesn't really work here.
guides/source/security.md
Outdated
| @@ -734,7 +734,7 @@ This JavaScript code will simply display an alert box. The next examples do exac | |||
|
|
|||
| These examples don't do any harm so far, so let's see how an attacker can steal the user's cookie (and thus hijack the user's session). In JavaScript you can use the `document.cookie` property to read and write the document's cookie. JavaScript enforces the same origin policy, that means a script from one domain cannot access cookies of another domain. The `document.cookie` property holds the cookie of the originating web server. However, you can read and write this property, if you embed the code directly in the HTML document (as it happens with XSS). Inject this anywhere in your web application to see your own cookie on the result page: | |||
|
|
|||
| ``` | |||
| ```js | |||
There was a problem hiding this comment.
Suggested change
| ```js | |
| ```html |
railties/CHANGELOG.md
Outdated
| @@ -4,7 +4,7 @@ | |||
|
|
|||
| Usage: | |||
|
|
|||
| ``` | |||
| ```bash | |||
| rails generate scaffold Pet name:string --database=animals | |||
There was a problem hiding this comment.
Suggested change
| rails generate scaffold Pet name:string --database=animals | |
| $ bin/rails generate scaffold Pet name:string --database=animals |
railties/CHANGELOG.md
Outdated
| @@ -27,7 +27,7 @@ | |||
|
|
|||
| If you already have an abstract class and it follows a different pattern than Rails defaults, you can pass a parent class with the database argument. | |||
|
|
|||
| ``` | |||
| ```bash | |||
| rails generate scaffold Pet name:string --database=animals --parent=SecondaryBase | |||
There was a problem hiding this comment.
Suggested change
| rails generate scaffold Pet name:string --database=animals --parent=SecondaryBase | |
| $ bin/rails generate scaffold Pet name:string --database=animals --parent=SecondaryBase |
chiraggshah
force-pushed
the
syntax-highlighting-improvements
branch
from
2961a5c
to
0302497
Compare
chiraggshah
force-pushed
the
syntax-highlighting-improvements
branch
from
0302497
to
84d6a0e
Compare
|
@jonathanhefner Thanks for the review. I have made the suggested changes. |
|
Thank you @chiraggshah! |
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.
Summary
The PR adds various languages to the fenced code blocks for better syntax highlighting