Skip to content

Commit 8447a72

Browse files
Convert examples from Markdown to RDoc [ci-skip]
This guide is about API documentation which uses RDoc, so we should avoid Markdown syntax in examples.
1 parent e8166c4 commit 8447a72

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

guides/source/api_documentation_guidelines.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,16 @@ Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite databa
7272

7373
Prefer wordings that avoid "you"s and "your"s. For example, instead of
7474

75-
```markdown
76-
If you need to use `return` statements in your callbacks, it is recommended that you explicitly define them as methods.
75+
```ruby
76+
# If you need to use +return+ statements in your callbacks, it is
77+
# recommended that you explicitly define them as methods.
7778
```
7879

7980
use this style:
8081

81-
```markdown
82-
If `return` is needed, it is recommended to explicitly define a method.
82+
```ruby
83+
# If +return+ is needed, it is recommended to explicitly define a
84+
# method.
8385
```
8486

8587
That said, when using pronouns in reference to a hypothetical person, such as "a
@@ -212,8 +214,9 @@ in the implementation.
212214

213215
For example:
214216

215-
```markdown
216-
`config.action_mailer.perform_deliveries` specifies whether mail will actually be delivered and is true by default
217+
```ruby
218+
# +config.action_mailer.perform_deliveries+ specifies whether mail
219+
# will actually be delivered and is true by default
217220
```
218221

219222
the user does not need to know which is the actual default value of the flag,

0 commit comments

Comments
 (0)