Skip to content

Commit 0e908bb

Browse files
Use ruby code fence [ci-skip]
These examples show RDoc in the form of Ruby comments, and should therefore use the `ruby` code fence (which matches the other examples in this guide).
1 parent 8447a72 commit 0e908bb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

guides/source/api_documentation_guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ When documenting the behavior for IRB, Ruby's interactive REPL, always prefix co
181181

182182
For example,
183183

184-
```irb
184+
```ruby
185185
# Find the customer with primary key (id) 10.
186186
# irb> customer = Customer.find(10)
187187
# # => #<Customer id: 10, first_name: "Ryan">
@@ -191,7 +191,7 @@ For example,
191191

192192
For command-line examples, always prefix the command with `$`, the output doesn't have to be prefixed with anything.
193193

194-
```bash
194+
```ruby
195195
# Run the following command:
196196
# $ bin/rails new zomg
197197
# ...

0 commit comments

Comments
 (0)