donut-party / datapotato

better database fixtures for Clojure tests! 🥔
Other
112 stars 1 forks source link

Wiki formatting fixes #6

Open gpind opened 9 months ago

gpind commented 9 months ago

I have a few formatting & typo fixes for the wiki. I don't think I can submit a PR, so here's the diff:

diff --git a/full-tutorial/03-queries.org b/full-tutorial/03-queries.org
index 8e9d901..9142aa6 100644
--- a/full-tutorial/03-queries.org
+++ b/full-tutorial/03-queries.org
@@ -27,14 +27,14 @@ Datapotato generates the ~:user~ ent ~:u0~. Datapotato only generates one
 owner; therefore one user is the minimum needed to satisfy the query.

 Queries are maps, where each key is the name of an ent type, and each value is a
-vector of /query terms/. In the query ~{:post [{:count 2}]}~, ~:post~ is an ent type
-and ~{:count 2}~ is a query term.
+vector of /query terms/. In the query ~{:post [{:count 2}]}~, ~:post~ is an ent
+type and ~{:count 2}~ is a query term.

 Query terms are maps. The ~:count~ key specifies how many ents to create.

-With ~{:count 2}~ you're instructing SM to generate 2 ents of the given ent
-type, and to name them according to the default naming system. As we saw in the
-last section, datapotato names ents by appending an index to the ent type's
+With ~{:count 2}~ you're instructing datapotato to generate 2 ents of the given
+ent type, and to name them according to the default naming system. As we saw in
+the last section, datapotato names ents by appending an index to the ent type's
 ~:prefix~. The ~:prefix~ for ~:post~ is ~:p~, so the ~:post~ ents are named
 ~:p0~ and ~:p1~. Figuring out what to name your test data is one of the tedious
 aspects of testing that datapotato handles for you.
diff --git a/full-tutorial/07-uniqueness-constraint.org b/full-tutorial/07-uniqueness-constraint.org
index 5368ab2..92d8d04 100644
--- a/full-tutorial/07-uniqueness-constraint.org
+++ b/full-tutorial/07-uniqueness-constraint.org
@@ -55,8 +55,8 @@ a /uniqueness constraint/ in the schema:

 Notice the ~:constraints~ key at the bottom of the schema. This tells
 Datapotato, "The ~:created-by-id~ relation of every ~:like~ should refer to a
-unique ~:user~. If you generate multiple ~:like~s, generate new ~:user~s too
-until each like refers to a differ ~:user~."
+unique ~:user~. If you generate multiple ~:like~ records, generate new ~:user~
+records too until each like refers to a different user."

 This schema will generate a graph that will satisfy your database's constraints:

@@ -70,8 +70,8 @@ This schema will generate a graph that will satisfy your database's constraints:
 [[https://raw.githubusercontent.com/donut-party/datapotato/main/docs/tutorial/images/07-ex-02.svg]]

 You could have instead added the ~:uniq~ constraint to ~:post-id~, and it would
-have generated new ~:post~s instead of ~:user~s. Give it a try :) Or, try adding
-the constraint to both ~:post-id~ and ~:created-by-id~.
+have generated new ~:post~ records instead of ~:user~. Give it a try :) Or, try
+adding the constraint to both ~:post-id~ and ~:created-by-id~.

 - *[[06-generating-records][Prev: 06 Generating Records]]*
 - *[[08-collection-constraint][Next: 08 Collection Constraint]]*