wip

Author: stephencelis

Sources/StructuredQueries/Macros.swift

@@ -46,7 +46,7 @@ public macro Column(
     type: "ColumnMacro"
   )
 
-/// Tells Structured Queries not to consider the annotated property a column of the table
+/// Tells StructuredQueries not to consider the annotated property a column of the table.
 ///
 /// Like SwiftData's `@Transient` macro, but for SQL.
 @attached(peer)

Sources/StructuredQueriesCore/Documentation.docc/Articles/Triggers.md

@@ -44,7 +44,8 @@ This will make it so that anytime a reminder is updated in the database its `upd
 refreshed with the current time immediately.
 
 This pattern of updating a timestamp when a row changes is so common that the library comes with
-a specialized tool just for that kind of trigger, ``Table/createTemporaryTrigger(_:ifNotExists:afterUpdateTouch:fileID:line:column:)``:
+a specialized tool just for that kind of trigger,
+``Table/createTemporaryTrigger(_:ifNotExists:afterUpdateTouch:fileID:line:column:)``:
 
 @Row {
   @Column {
@@ -97,28 +98,27 @@ comes with another specialized too just for that kind of trigger,
   }
 }
 
-
 ### More types of triggers
 
-There are 3 kinds of triggers depending on the event being listened for in the database: an 
-update trigger, an insert trigger, and a deletion trigger. For each of these kinds of triggers one
-can perform 4 kinds of actions: a select, insert, update or delete. All 12 combinations of these
-kinds of triggers are supported by the library.
+There are 3 kinds of triggers depending on the event being listened for in the database: inserts,
+updates, and deletes. For each of these kinds of triggers one can perform 4 kinds of actions: a
+select, insert, update, or delete. All 12 combinations of these kinds of triggers are supported by
+the library.
 
-> Note: Technically SQLite supports "BEFORE" triggers and "AFTER" triggers, but the documentation
-> recommends against using "BEFORE" triggers as it can lead to undefined behavior. Therefore 
-> Structured Queries does not expose "BEFORE" triggers in its API. If you want to go against the
-> recommendations of SQLite and create a "BEFORE" trigger, you can always write a trigger as a 
-> SQL string (see <docs:SafeSQLStrings> for more info).
+> Note: Technically SQLite supports `BEFORE` triggers and `AFTER` triggers, but the documentation
+> recommends against using `BEFORE` triggers as it can lead to undefined behavior. Therefore
+> StructuredQueries does not expose `BEFORE` triggers in its API. If you want to go against the
+> recommendations of SQLite and create a `BEFORE` trigger, you can always write a trigger as a SQL
+> string (see <docs:SafeSQLStrings> for more info).
 
 Here are a few examples to show you the possibilities with triggers:
 
 #### Non-empty tables
 
 One can use triggers to enforce that a table is never fully emptied out. For example, suppose you
-want to make sure that the "remindersLists" table always has at least one row. Then one can
-use an "AFTER DELETE" trigger with an "INSERT" action to insert a stub reminders list when it
-detects the last list was deleted:
+want to make sure that the `remindersLists` table always has at least one row. Then one can use an
+`AFTER DELETE` trigger with an `INSERT` action to insert a stub reminders list when it detects the
+last list was deleted:
 
 @Row {
   @Column {
@@ -153,15 +153,14 @@ detects the last list was deleted:
 
 #### Invoke Swift code from triggers
 
-One can use triggers with a "SELECT" action to invoke Swift code when an event occurs in your
+One can use triggers with a `SELECT` action to invoke Swift code when an event occurs in your
 database. For example, suppose you want to execute a Swift function a new reminder is inserted
 into the database. First you must register the function with SQLite and that depends on what
-SQLite driver you are using ([here][grdb-add-function] is how to do it in GRDB). Suppose we 
-registered a function called `didInsertReminder`, and further suppose it takes one argument
-of the ID of the newly inserted reminder.
+SQLite driver you are using ([here][grdb-add-function] is how to do it in GRDB).
 
-Then one can invoke this function whenever a reminder is inserted into the database with the 
-following trigger:
+Suppose we registered a function called `didInsertReminder`, and further suppose it takes one
+argument of the ID of the newly inserted reminder. Then one can invoke this function whenever a
+reminder is inserted into the database with the  following trigger:
 
 [grdb-add-function]: https://swiftpackageindex.com/groue/grdb.swift/v7.5.0/documentation/grdb/database/add(function:)