Skip to content

Commit 4a05b53

Browse files
authored
spelling: update docs, comments (#8831)
1 parent dc97aed commit 4a05b53

12 files changed

+16
-16
lines changed

docs/_posts/2014-09-07-pouchdb-3.0.5.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ We literally wrote [a custom JSON parser](https://github.com/nolanlawson/vuvuzel
2525

2626
The ["infinite recursion" bug](https://github.com/pouchdb/pouchdb/issues/2543) shows up when you have many (> 1000) revisions to the same document. For instance, imagine a text editor that `put()`s a new version of the document for every keystroke. This is fine in traditional databases, but it can be a big problem in PouchDB/CouchDB, because we store the entire history of the database.
2727

28-
Make no mistake: inifinitely-large revision histories will now work in PouchDB 3.0.5. However, it's a lot like riding a bicycle without a helmet: you _can_ do it, but you probably shouldn't.
28+
Make no mistake: infinitely-large revision histories will now work in PouchDB 3.0.5. However, it's a lot like riding a bicycle without a helmet: you _can_ do it, but you probably shouldn't.
2929

3030
Your mental model for this can be something like Git. Imagine a new `git commit` for every keystroke, and you'll see why it might be a bit problematic.
3131

@@ -45,4 +45,4 @@ Your mental model for this can be something like Git. Imagine a new `git commit`
4545

4646
Of course, you can always `compact()` to remove old versions, but this just removes the document data. PouchDB still needs to maintain a permanent tree of the `_rev` hashes in order for the replication algorithm to work properly. If this tree grows excessively, it can bloat your database, whether or not you do compaction.
4747

48-
What this means is that you should be very careful about updating your documents. Try to update your documents in larger batches, or use a pattern like [delta-pouch](https://github.com/redgeoff/delta-pouch) to avoid creating new revisions altogether.
48+
What this means is that you should be very careful about updating your documents. Try to update your documents in larger batches, or use a pattern like [delta-pouch](https://github.com/redgeoff/delta-pouch) to avoid creating new revisions altogether.

docs/_posts/2014-10-26-10-things-i-learned-from-reading-and-writing-the-pouchdb-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ User agent sniffing! Yes, we should be ashamed of ourselves. But here's why we d
4343
* Additionally, if you specify anywhere between 0 and 5000000, Safari and iOS will use that size as a hint for when, precisely, to show the popup. And in the case of PouchDB, we need to avoid the popup in our automated tests, because Selenium doesn't give us a way to press the "OK" button, meaning our tests would just fail if we request too much. So the ideal size to request is 0.
4444
* However, in **PhantomJS** and older WebKit (Safari ~5), if you request 0, then it will blow up.
4545

46-
For the recored, here's what the dreaded Safari popup looks like:
46+
For the record, here's what the dreaded Safari popup looks like:
4747

4848
{% include img.html src="safari_popup.png" alt="annoying Safari popup" %}
4949

docs/_posts/2014-11-10-3.1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ We keep a list of [plugins and related external projects]({{ site.baseurl }}/ext
3131

3232
* PouchDB [Dump](https://github.com/nolanlawson/pouchdb-dump-cli) and [Load](https://github.com/nolanlawson/pouchdb-load) are designed to help you load data into your newly started PouchDB app faster than replication will do currently.
3333
* If you want to use PouchDB with Angular, you are in luck, there are now 4! adapters to help you integrate them: [angular-pouchdb](https://github.com/wspringer/angular-pouchdb), [Factoryng](https://github.com/redgeoff/factoryng), [ngPouch](https://github.com/jrhicks/ngPouch), [ng-pouchdb](https://github.com/danielzen/ng-pouchdb).
34-
* Ember users arent left in the wild: [ember-pouchdb](https://github.com/taras/ember-pouchdb) should get you going with PouchDB and Ember.
34+
* Ember users aren't left in the wild: [ember-pouchdb](https://github.com/taras/ember-pouchdb) should get you going with PouchDB and Ember.
3535
* If you are using Blobs with PouchDB, you probably want to take a look at [blob-util](https://github.com/nolanlawson/blob-util).
3636

3737
### Bug fixes Galore

docs/_posts/2014-11-27-testing-pouchdb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ We use [Selenium](http://www.seleniumhq.org/) to drive tests in the browser, and
4545

4646
We are also finding some platforms (particularly iPhone and Internet Explorer) will become unstable on Saucelabs. The errors almost always come from our code, but it is hard to maintain a reliable test suite when the underlying platform changes and you have little control over it.
4747

48-
Before settling on Selenium, I had previously tried out [Testling](https://ci.testling.com/), and similiarly to Tape it was very easy to get started but opinionated. It was also broken on OSX with pull requests containing fixes that hadn't been touched for months. Selenium had the advantage that it was very widely used, and new frameworks or platforms are likely to have WebDriver support early on.
48+
Before settling on Selenium, I had previously tried out [Testling](https://ci.testling.com/), and similarly to Tape it was very easy to get started but opinionated. It was also broken on OSX with pull requests containing fixes that hadn't been touched for months. Selenium had the advantage that it was very widely used, and new frameworks or platforms are likely to have WebDriver support early on.
4949

5050
I have however found Selenium as a project frustrating to use, from the first time visiting [http://www.seleniumhq.org/](http://www.seleniumhq.org/) to understanding what I needed to download and write a first test that started a browser, it was an unclear and confusing process. Even today getting ChromeDriver started correctly gets me confused, also the download cost of 30MB for what is mostly a proxy server is an annoyance.
5151

docs/_posts/2015-03-05-taming-the-async-beast-with-es7.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ So if you want to play with it yourself, I've put together a [small demo library
324324

325325
### Conclusion
326326

327-
Async functions are an empowering new concept in ES7. They give us back our lost `return`s and `try`/`catch`es, and they reward the knowledge we've already gained from writing synchronous code with new idiioms that look a lot like the old ones, but are much more performant.
327+
Async functions are an empowering new concept in ES7. They give us back our lost `return`s and `try`/`catch`es, and they reward the knowledge we've already gained from writing synchronous code with new idioms that look a lot like the old ones, but are much more performant.
328328

329329
Most importantly, async functions make APIs like PouchDB's a lot easier to work with. So hopefully this will lead to fewer user errors and confusion, as well as more elegant and readable code.
330330

docs/_posts/2022-11-11-pouchdb-7.3.1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ We're happy to announce the release of PouchDB 7.3.1, bringing in some fixes and
1212

1313
### Bugfixes
1414

15-
* [7db104c5](https://github.com/pouchdb/pouchdb/commit/7db104c56248738598feb7ca1f22bc3b7bbd69be) ([#8463](https://github.com/pouchdb/pouchdb/issues/8463)) - check if docFieldValue is also null value. typeof null returns object in javasctipy. Fixes a bug when querying against and array with a null value, $elemMatch and $allMatch.
15+
* [7db104c5](https://github.com/pouchdb/pouchdb/commit/7db104c56248738598feb7ca1f22bc3b7bbd69be) ([#8463](https://github.com/pouchdb/pouchdb/issues/8463)) - check if docFieldValue is also null value. typeof null returns object in javascript. Fixes a bug when querying against and array with a null value, $elemMatch and $allMatch.
1616
* [719502dc](https://github.com/pouchdb/pouchdb/commit/719502dc6a75851dce9d0a35e44929b25943588c) ([#8225](https://github.com/pouchdb/pouchdb/issues/8225)) - Added check for blob.type setter
17-
* [d5bb7bd6](https://github.com/pouchdb/pouchdb/commit/d5bb7bd6330339448f5918592bd69df78166bad2) ([#8389](https://github.com/pouchdb/pouchdb/pull/8389)) - `_id` was mappped to `data._id` instead of id
17+
* [d5bb7bd6](https://github.com/pouchdb/pouchdb/commit/d5bb7bd6330339448f5918592bd69df78166bad2) ([#8389](https://github.com/pouchdb/pouchdb/pull/8389)) - `_id` was mapped to `data._id` instead of id
1818
* [bbeb7e55](https://github.com/pouchdb/pouchdb/commit/bbeb7e557658fb405b5cf91dec50a79faf5278a3) ([#8531](https://github.com/pouchdb/pouchdb/pull/8531)) - fix sorted find including deleted docs
1919

2020
### Testing

docs/_posts/2022-12-14-pouchdb-8.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Example result:
9696
* [774976a0](https://github.com/pouchdb/pouchdb/commit/774976a02781c3953727244706adfb0d5cce420a) feat: on-update view purging
9797
* [94ec8932](https://github.com/pouchdb/pouchdb/commit/94ec8932fd79a2993c82a5381ae34d64c286375f) feat(core): `purged_infos_limit` support
9898
* [ce8f8b30](https://github.com/pouchdb/pouchdb/commit/ce8f8b308f4509def96272693f797deac05b55e0) [wip] Purge leaves from multiple roots
99-
* [4252a0f0](https://github.com/pouchdb/pouchdb/commit/4252a0f0ba71ab63f493709fe81e5e63baeb5dee) docs(purge): show result object seperately
99+
* [4252a0f0](https://github.com/pouchdb/pouchdb/commit/4252a0f0ba71ab63f493709fe81e5e63baeb5dee) docs(purge): show result object separately
100100
* [b856173b](https://github.com/pouchdb/pouchdb/commit/b856173b436c201d86c0c63319eaf0dc8396a772) chore(purge): add code comments
101101
* [d5f4250a](https://github.com/pouchdb/pouchdb/commit/d5f4250a3539b62c430203441bcb02fa41e00ae2) chore(purge): remove unneeded logs and comments
102102
* [2c0ddbb0](https://github.com/pouchdb/pouchdb/commit/2c0ddbb01e9d01ba2b4ccc754ff855a15173208c) feat(purge): simplify implementation of removeLeafFromTree()

docs/external.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ AngularJS binding for PouchDB.
215215

216216
#### [ampersand-collection-pouchdb-mixin](https://github.com/svnlto/ampersand-collection-pouchdb-mixin)
217217

218-
A mixin for extending ampersand-collection with pouchdb persistance.
218+
A mixin for extending ampersand-collection with pouchdb persistence.
219219

220220
### Backbone
221221

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ function checkboxChanged(todo, event) {
127127
}
128128
{% endhighlight %}
129129

130-
This is similar to creating a document, however the document must also contain a `_rev` field (in addition to `_id`), otherwise the write will be rejected. This ensures that you don't accidently overwrite changes to a document.
130+
This is similar to creating a document, however the document must also contain a `_rev` field (in addition to `_id`), otherwise the write will be rejected. This ensures that you don't accidentally overwrite changes to a document.
131131

132132
You can test that this works by checking a todo item and refreshing the page. It should stay checked.
133133

@@ -141,7 +141,7 @@ function deleteButtonPressed(todo) {
141141
}
142142
{% endhighlight %}
143143

144-
Similiar to editing a document, both the `_id` and `_rev` properties are required. You may notice that we are passing around the full object that we previously read from the database. You can of course manually construct the object, like: `{_id: todo._id, _rev: todo._rev}`, but passing around the existing object is usually more convenient and less error prone.
144+
Similar to editing a document, both the `_id` and `_rev` properties are required. You may notice that we are passing around the full object that we previously read from the database. You can of course manually construct the object, like: `{_id: todo._id, _rev: todo._rev}`, but passing around the existing object is usually more convenient and less error prone.
145145

146146
{% include anchor.html class="h3" title="Complete rest of the Todo UI" hash="complete_todo_ui" %}
147147

docs/gql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ The above query will return
169169

170170
## Functions
171171

172-
GQL contains a number of operators and functions that can operate on retrived documents.
172+
GQL contains a number of operators and functions that can operate on retrieved documents.
173173

174174
### Aggregation Functions
175175

@@ -203,7 +203,7 @@ identifier as their input. Scalar functions may only appear in the select and l
203203

204204
With these documents in the database
205205

206-
{name!: "pencil", price: 2, discount: 0.7, vender: "store1"},
206+
{name!: "pencil", price: 2, discount: 0.7, vendor: "store1"},
207207
{name!: "pen", price:3, discount: 2, vendor: "store2"}
208208

209209
The above query will return

0 commit comments

Comments
 (0)