Skip to content

Commit 1702b6c

Browse files
authored
Merge pull request rails#50592 from p8/guides/expand-wording
Add Naming and Pronouns headings to API wording guide [ci-skip]
2 parents a2ed343 + d1ccf34 commit 1702b6c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

guides/source/api_documentation_guidelines.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ Communicate to the reader the current way of doing things, both explicitly and i
6262

6363
Documentation has to be brief but comprehensive. Explore and document edge cases. What happens if a module is anonymous? What if a collection is empty? What if an argument is nil?
6464

65+
### Naming
66+
6567
The proper names of Rails components have a space in between the words, like "Active Support". `ActiveRecord` is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper names.
6668

6769
When referencing a "Rails application", as opposed to an "engine" or "plugin", always use "application". Rails apps are not "services", unless specifically discussing about service-oriented architecture.
@@ -70,6 +72,8 @@ Spell names correctly: Arel, minitest, RSpec, HTML, MySQL, JavaScript, ERB, Hotw
7072

7173
Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database".
7274

75+
### Pronouns
76+
7377
Prefer wordings that avoid "you"s and "your"s. For example, instead of
7478

7579
```ruby

0 commit comments

Comments
 (0)