aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/api_documentation_guidelines.md
Commit message (Collapse)AuthorAgeFilesLines
* Use new RDoc URL of Ruby core [ci skip]aycabta2017-11-101-3/+3
|
* Merge pull request #30213 from ckundo/ccundiff-alt-text-defaultRafael Mendonça França2017-08-231-1/+1
|\ | | | | | | Do not generate default alt text for images
| * Do not generate default alt text in image tagsCameron Cundiff2017-08-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Auto-generating content from the filename of an image is not suitable alternative text; alt text that isn't fully considered can be distracting and fatiguing for screen readers users (blind, low vision, dyslexic people). - Setting a filename fallback short circuits screen reader default behavior and configuration for blank descriptions. - Setting poor defaults also creates false negatives for accessibility linting and testing software, that makes it harder to improve application accessibility. *** - After this change, if authors leave images without alt text, screen readers will fallback to default behavior for missing alt text. - Also with this change, Automated linting and testing tools will correctly generate warnings. [Fixes #30096]
* | Use https instead of http in guide [ci skip]Yoshiyuki Hirano2017-08-231-2/+2
|/
* We always + 1 to __LINE__ when class_evaling with <<Akira Matsuda2017-05-221-1/+1
| | | | [ci skip]
* Remove mentions and instructions for docrailsMatthew Draper2017-04-091-4/+0
| | | | It's been retired; all contributions now come in via PRs.
* [ci skip] correction in command for generating api documentationDavid Elliott2016-06-201-1/+1
| | | | | | | | reverts change in previous commit https://github.com/rails/rails/commit/ea4f0e2 docs should prefer to use `rails` over `rake` in the context of an application, but in the context of the Rails source this is not the case
* Support for unified Integer class in Ruby 2.4+Jeremy Daer2016-05-181-1/+1
| | | | | | | | Ruby 2.4 unifies Fixnum and Bignum into Integer: https://bugs.ruby-lang.org/issues/12005 * Forward compat with new unified Integer class in Ruby 2.4+. * Backward compat with separate Fixnum/Bignum in Ruby 2.2 & 2.3. * Drops needless Fixnum distinction in docs, preferring Integer.
* Refer to rails command instead of rake in a bunch of placesDavid Heinemeier Hansson2015-12-181-1/+1
| | | | Still more to do. Please assist!
* API guidelines reword re the Oxford comma [ci skip]Xavier Noria2015-10-221-3/+4
|
* Replace `#=>` with `# =>` [ci skip]amitkumarsuroliya2015-09-191-1/+1
| | | | @rafaelfranca suggested in https://github.com/rails/rails/commit/f7c7bcd9c2a8b0e8c2840295d001d2d4dfd4cfae that code examples should display the result after `# =>` and not after `#=>`.
* [ci skip] Fix the grammaryui-knk2015-08-241-1/+1
| | | | This is discussed on https://github.com/rails/rails/pull/21334
* [ci skip] Add style guide about commayui-knk2015-08-231-0/+5
|
* Update instructions to build guides locally [ci skip]Achilleas Pipinellis2015-04-281-1/+2
| | | | | | 1. Make clear where rake rdoc is executed 2. Make clear where the generated HTML files for the guides are stored 3. Use bundler 1.3.5 or later
* - Changed `IN` to `ON` in markdown renderer conditionVipul A M2015-01-141-1/+1
| | | | - Changed `IN` to `ON` in all note sentences in guides.
* warn about reading guides in GitHubXavier Noria2014-12-231-0/+2
| | | | References #18148.
* correct markdown usage [ci skip]Nishant Modak2014-07-091-1/+1
|
* Copy edits from e0f3f1a [ci skip]Zachary Scott2014-06-131-3/+7
| | | | | - image_tag is an instance method - explain possible results when asset pipeline is used
* Document behavior concerns regarding the full Rails stack [ci skip]Zachary Scott2014-06-131-0/+24
| | | | Related to a discussion on #15508
* Add links to RDoc back into API documentation guidelines [ci skip]Zachary Scott2014-06-131-1/+7
| | | | These were removed from #15542 unfortunately :(
* copy edits [ci skip]Vijay Dev2014-06-071-1/+1
|
* remove rubyforge.org that was shut down [ci skip]Gaurav Sharma2014-06-061-1/+7
|
* Rename Posts to Articles in Guides, continuation of 2d446e77 / #13774 [ci skip]John Kelly Ferguson2014-05-211-6/+6
|
* copy edits[ci skip]Vijay Dev2014-05-181-7/+6
|
* Document method visibility for designing API docs. [ci skip]Zachary Scott2014-05-171-0/+34
| | | | cc https://github.com/rails/rails/issues/14848#issuecomment-41198795
* prefer file name instead of filename [ci skip]Vijay Dev2014-05-171-2/+2
|
* 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
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 15:13:03 +0000