From b3b3fdc7a40476d5d8fb4d33d34719f537e676fd Mon Sep 17 00:00:00 2001 From: Hudson Date: Wed, 14 Oct 2015 13:45:10 -0300 Subject: [PATCH] Improve documentation: fixed typos on Readme and added dollar sign at Contributing [ci skip] --- CONTRIBUTING.md | 6 +++--- README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d6e9318..5a164f11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,8 +47,8 @@ Rake can be found at http://docs.seattlerb.org/rake/. To run a single test suite - rake test TEST=path/to/test.rb +`$ rake test TEST=path/to/test.rb` -which can be further narrowed down to one test: +Which can be further narrowed down to one test: - rake test TEST=path/to/test.rb TESTOPTS="--name=test_something" +`$ rake test TEST=path/to/test.rb TESTOPTS="--name=test_something"` diff --git a/README.md b/README.md index 61cbf654..450b6562 100644 --- a/README.md +++ b/README.md @@ -200,12 +200,12 @@ end #### Attributes It's the default adapter, it generates a json response without a root key. -Doesn't follow any specifc convention. +Doesn't follow any specific convention. #### JSON It also generates a json response but always with a root key. The root key **can't be overridden**, and will be automatically defined accordingly with the objects being serialized. -Doesn't follow any specifc convention. +Doesn't follow any specific convention. #### JSON API @@ -271,7 +271,7 @@ the serializer generator: $ rails g serializer post ``` -The generated seralizer will contain basic `attributes` and +The generated serializer will contain basic `attributes` and `has_many`/`has_one`/`belongs_to` declarations, based on the model. For example: ```ruby