diff options
author | Xavier Noria <fxn@hashref.com> | 2018-09-11 23:52:27 +0200 |
---|---|---|
committer | Xavier Noria <fxn@hashref.com> | 2018-09-11 23:57:25 +0200 |
commit | f589e20b0a865a7efd93e65b2887f0e4ab9a556f (patch) | |
tree | e9b0c87c3ade2befb7a679e0ad6181675971ab61 /guides/source/api_documentation_guidelines.md | |
parent | e9ae7a1514d660fee8cacc6a9aa7524f6f4617e3 (diff) | |
download | rails-f589e20b0a865a7efd93e65b2887f0e4ab9a556f.tar.gz rails-f589e20b0a865a7efd93e65b2887f0e4ab9a556f.tar.bz2 rails-f589e20b0a865a7efd93e65b2887f0e4ab9a556f.zip |
use "minitest" consistently
The name of the minitest library is spelled that way: regular font, and
lowercase. Lowercase is used even at the beginning of sentences, see
http://docs.seattlerb.org/minitest/
I double-checked this with @zenspider too (thanks!).
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
-rw-r--r-- | guides/source/api_documentation_guidelines.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 6efd9296dc..b6ee7354f9 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -53,7 +53,7 @@ Documentation has to be concise but comprehensive. Explore and document edge cas 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 name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be phenomenal. -Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERB. When in doubt, please have a look at some authoritative source like their official documentation. +Spell names correctly: Arel, minitest, RSpec, HTML, MySQL, JavaScript, ERB. When in doubt, please have a look at some authoritative source like their official documentation. Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database". |