Michael Lavrisha
941fae2cbb
Provide consistant indentation for the example code
2011-07-24 13:59:52 -06:00
Carol Nichols
9b9cf92768
Changing Textile emphasis underscores to em tags; the link with underscores that follows is causing the emphasis underscores to be parsed incorrectly.
...
This appears to be a bug with RedCloth; parsing with official Textile creates the HTML that I expect. I have filed ticket # 226 on RedCloth's lighthouse project and I will attempt to fix the problem with RedCloth.
This commit is a workaround for the RedCloth bug that will give this guide the right formatting.
2011-07-23 15:27:07 -04:00
Xavier Noria
5e21247131
Merge branch 'master' of git://github.com/lifo/docrails
...
Conflicts:
activerecord/RUNNING_UNIT_TESTS
2011-06-06 22:23:30 +02:00
Xavier Noria
576f712380
standarize documentation (and indirectly code) to use American English as discussed in 4f234bf
...
Please do not perform monster patches for this until 3.1 is out.
Also, no existing API should be affected by this. New code, local
variables, etc. would follow this guideline to have a consistent
project tree in this regard.
2011-05-31 22:56:31 +02:00
Hendy Tanata
b13a0ceb5f
Fix punctuation.
2011-05-31 17:09:33 +08:00
Hendy Tanata
bdd7ecb34e
Update Rails coding conventions link.
2011-05-31 16:53:53 +08:00
Akira Matsuda
9bf5cddd28
s/ERb/ERB/g (part II)
2011-04-03 16:59:37 +09:00
Xavier Noria
f41bf6938f
merges docrails
2011-02-18 23:22:15 +01:00
jonnii
46ebbcd56b
Change fenomenal to phenomenal.
2011-02-10 12:22:19 -08:00
Xavier Noria
cb1f8413de
now that the API guidelines are a guide, it is enough to assert that the names of Rails components have a space, no need to say it was checked with David in the past
2011-02-09 20:05:28 +01:00
Xavier Noria
0b5222fa45
API guidelines: RDoc markup documentation has been moved in RDoc 3
2010-12-23 00:23:22 +01:00
Vijay Dev
eaad8610ee
minor example fix for Rails 3
2010-12-19 23:37:22 +05:30
Xavier Noria
c577e90f61
restores the example for fixed-width font in API guidelines
2010-11-10 23:46:00 +01:00
Santiago Pastorino
7a2be37592
Remove copy_instance_variables_from from guides
2010-11-10 19:12:10 -02:00
Xavier Noria
ba1fb51fa5
api guidelines: adds a reference to the RDoc documentation where directives like :method: are covered
2010-10-19 22:45:51 +02:00
Xavier Noria
a6aa6da5dd
api guidelines: adds Test::Unit and RSpec as examples of correct spelling, also advice when in doubt
2010-09-21 23:50:57 +02:00
Xavier Noria
2b6c2e947b
adds to the API guidelines the proper spelling of Arel
2010-09-19 00:05:05 +02:00
Santiago Pastorino
b451de0d6d
Deletes trailing whitespaces (over text files only find * -type f -exec sed 's/[ \t]*$//' -i {} \;)
2010-08-14 04:12:33 -03:00
Xavier Noria
d191db76e0
standarizes the use of the article "an" for "SQL" and "SQLite"
2010-08-05 01:09:09 +02:00
Xavier Noria
caddee253c
new guide: API Documentation Guidelines, ported and revised from the docrails github wiki
2010-07-17 19:42:44 +02:00
