aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/api_documentation_guidelines.md
Commit message (Collapse)AuthorAgeFilesLines
* Add tip about using RDoc's --pipe command to quickly test the output ofZachary Scott2014-02-101-0/+7
| | | | | | | a piece of documentation. This can be useful for trying out combinations of markup and code, as discussed in rails/rails@225bcad
* Merge branch 'master' of github.com:rails/docrailsVijay Dev2014-02-091-1/+1
|\ | | | | | | | | | | | | Conflicts: guides/source/active_record_validations.md guides/source/api_documentation_guidelines.md guides/source/configuring.md
| * Fixed a grammatical error in Booleans section of API documentation guideZachary Scott2014-02-091-1/+1
| | | | | | | | from e1e17a5
| * adds a section about booleans in the API guidelines [ci skip]Xavier Noria2014-02-091-0/+47
| |
* | adds a section about booleans in the API guidelines [ci skip]Xavier Noria2014-01-261-0/+47
| |
* | API guidelines: revises warning about +...+ [ci skip]Xavier Noria2014-01-261-1/+4
|/ | | | | | Modern RDoc accepts a few more things in +...+. In particular symbols work now. The current regexp in RDoc is https://github.com/rdoc/rdoc/blob/v4.1.1/lib/rdoc/markup/attribute_manager.rb#L133.
* Merge branch 'master' of github.com:lifo/docrailsVijay Dev2013-12-201-1/+1
|\
| * Remove an extra periodRobin Dupret2013-12-041-1/+1
| | | | | | | | As a side not, the period after etc is not always needed http://en.wiktionary.org/wiki/etc
* | docs guidelines: recommends wording in a way that avoids "you"s and "your"sXavier Noria2013-12-121-1/+15
| |
* | Add examples for gender neutral pronounsGuillermo Iguaran2013-12-011-1/+7
| |
* | Update API docs guidelines with reference about gender neutral pronounsGuillermo Iguaran2013-12-011-0/+2
|/
* cleans the guides sources from fancy non-ASCII stuffXavier Noria2013-08-231-1/+1
|
* Remove double spaces in guidesSunny Ripert2013-05-281-1/+1
|
* End-of-line whitespace huntSunny Ripert2013-05-281-2/+2
|
* copy edits [ci skip]Vijay Dev2012-12-081-2/+1
|
* Fill out API Documentation Guidelines 'you will learn' list.Steve Klabnik2012-12-071-0/+4
|
* Normalize on 'After reading this guide, you will know:'Steve Klabnik2012-11-291-0/+2
| | | | | We have three or four different introduction sentences to the guides. After this commit, we use the same one everywhere.
* make comments fit the comment boxes (mostly) in API doc guidesburningTyger2012-11-101-10/+13
|
* Revert "divided into folder with the language"Rafael Mendonça França2012-10-171-0/+201
| | | | | | This reverts commit f5b9ed4fbc3215a5fce48985ea372ad3f1182252. REASON: Translation work can not be done in the docrails repository
* divided into folder with the languageRodrigo Martins2012-10-171-201/+0
|
* 1.9 hash syntax changes.AvnerCohen2012-10-121-2/+2
|
* Fix the usage of `*` in MarkdownPrem Sichanugrist2012-09-171-1/+1
| | | | | In Textile `*` would convert to `<strong>`, but in Markdown we have to use `**` instead.
* Fix remaining formatting problems in the guidePrem Sichanugrist2012-09-171-8/+9
|
* Convert all the links into Markdown formatPrem Sichanugrist2012-09-171-3/+3
|
* Convert all inline codes to Markdown syntaxPrem Sichanugrist2012-09-171-6/+6
|
* Convert inline code tags to MarkdownPrem Sichanugrist2012-09-171-9/+9
|
* Convert heading tags and heading sectionPrem Sichanugrist2012-09-171-12/+21
|
* Convert code blocks into GFM stylePrem Sichanugrist2012-09-171-24/+24
|
* Rename the rest of the guides to MarkdownPrem Sichanugrist2012-09-171-0/+191