dfahlander
Improve grammar, consistency, and clarity
Thanks for your work on Dexie, @dfahlander. I've thoroughly enjoyed using it.
For the most part, the documentation has been very useful and illustrative. That said, I've noticed in several places that there are grammatical errors, inconsistencies, and areas where clarity and readability can be improved.
I'm happy to take on this task and make the changes myself, but they're likely to be quite widespread (even if typically small) and I wanted to be sure it was something you'd approve of before I put in the work.
Dexie is excellent and, to the best of my ability, I want the site and documentation to reflect that.
I've included a few examples below.
On the main page, in the Performant section:
Dexie has an near-native performance. It's' bulk operations utilize a rarely used feature in indexedDB - to ignore success callbacks when possible.
Though they're small mistakes, it's unfortunate for them to be among the first things one might see when investigating the possible use of Dexie:
Dexie has near-native performance. Its bulk operations utilize a rarely used feature in IndexedDB, ignoring success callbacks when possible.
This can be taken a step further stylistically, which improves how it flows when reading:
Dexie has near-native performance. Its bulk operations utilize an often-overlooked feature in IndexedDB, ignoring success callbacks when possible.
In the documentation on Table.bulkPut():
If some operations fail, bulkPut() will ignore those failures but return a rejected Promise with a Dexie.BulkError referencing failures. If caller does not catch that error, transaction will abort. If caller wants to ignore the failures, the bulkPut() operations must be caught.
Clarity and readability can be improved with a few small additions and changes:
If some operations fail, bulkPut() will ignore those failures and return a rejected Promise with a Dexie.BulkError referencing the failures. If the caller does not catch the error, the transaction will abort. If the caller wants to ignore the failures, the bulkPut() operations must be caught.
I would appreciate it very much. Thanks for your engagement. I would approve any grammatical and clarifying corrections :)
