Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Misc formatting and wording changes.

  • Loading branch information...
commit ed25960ceae0acdccb41b3b5435b92122c28e1f6 1 parent da9751d
@postmodern postmodern authored
Showing with 19 additions and 19 deletions.
  1. +8 −8 getting-started.md
  2. +9 −9 using-git.md
  3. +2 −2 why.md
View
16 getting-started.md
@@ -89,7 +89,7 @@ First, you will need to install an Adapter, which allows DataMapper to communica
Install DataMapper
------------------
-If you have RubyGems installed, pop open your console and install a few things.
+If you have RubyGems installed, open a Terminal and install a few things.
gem install data_mapper
@@ -135,7 +135,7 @@ You need to make sure to do this before you use your models, i.e. before you act
DataMapper.setup(:default, 'postgres://localhost/the_database_name')
{% endhighlight %}
-NOTE that currently you **must** setup a `:default` repository to work
+**Note**: that currently you **must** setup a `:default` repository to work
with DataMapper (and to be able to [use additional differently named
repositories](/docs/misc)). This might change in the future.
@@ -193,8 +193,8 @@ Associations
------------
Ideally, these declarations should be done inside your class definition with the
-properties and things, but for demonstration purposes, we’re just going to crack
-open the classes.
+properties and things, but for demonstration purposes, we will just
+re-open the classes.
### One To Many
@@ -275,9 +275,9 @@ Set up your database tables
---------------------------
Relational Databases work with pre-defined tables. To be able to create the tables in the
-underlying storage, you need to have `dm-migrations` available on your load path.
+underlying storage, you need to have `dm-migrations` loaded.
-If you've been following this instructions and did `require 'data_mapper'`,
+**Note:** If you've been following this instructions and did `require 'data_mapper'`,
you can safely skip the following require statement as it has already
been done for you.
@@ -285,7 +285,7 @@ been done for you.
require 'dm-migrations'
{% endhighlight %}
-Once you made sure that `dm-migrations` is available, you can create the tables by issuing the following command.
+Once `dm-migrations` is loaded, you can create the tables by issuing the following command:
{% highlight ruby %}
DataMapper.auto_migrate!
@@ -304,7 +304,7 @@ DataMapper.auto_upgrade!
This tries to make the schema match the model. It will `CREATE` new tables, and
add columns to existing tables. It won't change any existing columns though
-(say, to add a NOT NULL constraint) and it doesn't drop any columns. Both these commands
+(say, to add a `NOT NULL` constraint) and it doesn't drop any columns. Both these commands
also can be used on an individual model (e.g. `Post.auto_migrate!`)
Create your first resource
View
18 using-git.md
@@ -6,16 +6,16 @@ title: Using Git
{{ page.title }}
================
-The DataMapper project uses the Git <span class="caps">SCM</span>. Committers
+The DataMapper project uses the Git SCM. Committers
need to use git to commit their code directly to the main repository.
This page contains information on getting Git installed, getting source code
with Git, and steps for working with Git.
-Also, see these references: <a href="http://git-scm.com/course/svn.html">Git
-&#8211; <span class="caps">SVN</span> Crash Course</a> and <a
-href="http://www.kernel.org/pub/software/scm/git/docs/everyday.html">Everyday
-<span class="caps">GIT</span> With 20 Commands Or So</a>
+Also, see these references:
+
+* [Git - SVN Crash Course](http://git-scm.com/course/svn.html)
+* [Everyday Git With 20 Commands Or So](http://www.kernel.org/pub/software/scm/git/docs/everyday.html)
Getting Git for Your System
---------------------------
@@ -67,7 +67,7 @@ Fixes for Module#make_my_day return values.
Getting the Code
----------------
-DataMapper is hosted at <a href="http://github.com/datamapper/">GitHub</a>.
+DataMapper is hosted at [GitHub](http://github.com/datamapper/).
Getting the code is easy once you have git installed but is slightly different
depending on your access. In both cases that exact command will put the
repository in a local directory called dm. You can give it a different name just
@@ -88,10 +88,10 @@ git clone git@github.com/datamapper/dm-core.git
Git Workflow
------------
-Working with Git is significantly different than working with <span
-class="caps">SVN</span>. In particular, although similar, git pull is not svn
+Working with Git is significantly different than working with
+SVN. In particular, although similar, git pull is not svn
update, git push is not svn commit, and git add is not svn add. If you are a
-<span class="caps">SVN</span> user, be sure to read the man pages for the
+SVN user, be sure to read the man pages for the
different git commands.</p>
The following workflow is recommended by Rein and is the guideline for
View
4 why.md
@@ -93,7 +93,7 @@ There are still some limitations to the operations that `#auto_upgrade!`
can perform. We're working hard on making it smarter, but there will
always be scenarios where an automatic upgrade of your schema won't be
possible. For example, there's no sane strategy for automatically changing
-a column length constraint from VARCHAR(100) to VARCHAR(50). DataMapper
+a column length constraint from `VARCHAR(100)` to `VARCHAR(50)`. DataMapper
can't know what it should do when the data doesn't validate against the
new tightened constraints.
@@ -234,7 +234,7 @@ start iterating over `zoos` or call one of the 'kicker' methods like `#length`.
If you never do anything with the results of a query, DataMapper won't incur the
latency of talking to your data-store.
-NOTE that this currently doesn't work when you start to nest loops
+**Note:** that this currently doesn't work when you start to nest loops
that access the associations more than one level deep. The following
would *not* issue the optimal amount of queries:
Please sign in to comment.
Something went wrong with that request. Please try again.