Skip to content

Commit 14fb194

Browse files
committed
Fix documentation
1 parent 33cdf6f commit 14fb194

File tree

4 files changed

+7
-13
lines changed

4 files changed

+7
-13
lines changed

GRDB/Core/Database.swift

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -878,13 +878,15 @@ public final class Database: CustomStringConvertible, CustomDebugStringConvertib
878878
// MARK: - Database Suspension
879879

880880
/// When this notification is posted, databases which were opened with the
881-
/// `Configuration.observesSuspensionNotifications` flag are suspended.
881+
/// ``Configuration/observesSuspensionNotifications`` configuration flag
882+
/// are suspended.
882883
///
883884
/// - note: [**🔥 EXPERIMENTAL**](https://github.com/groue/GRDB.swift/blob/master/README.md#what-are-experimental-features)
884885
public static let suspendNotification = Notification.Name("GRDB.Database.Suspend")
885886

886887
/// When this notification is posted, databases which were opened with the
887-
/// `Configuration.observesSuspensionNotifications` flag are resumed.
888+
/// ``Configuration/observesSuspensionNotifications`` configuration flag
889+
/// are resumed.
888890
///
889891
/// - note: [**🔥 EXPERIMENTAL**](https://github.com/groue/GRDB.swift/blob/master/README.md#what-are-experimental-features)
890892
public static let resumeNotification = Notification.Name("GRDB.Database.Resume")

GRDB/Core/DatabaseWriter.swift

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -570,10 +570,6 @@ extension DatabaseWriter {
570570
/// execution of the closure. Do not store or return the database connection
571571
/// for later use.
572572
///
573-
/// It is a programmer error to call this method from another database
574-
/// access method. Doing so raises a "Database methods are not reentrant"
575-
/// fatal error at runtime.
576-
///
577573
/// - parameter updates: A closure which accesses the database.
578574
/// - throws: The error thrown by `updates`, or any ``DatabaseError`` that
579575
/// would happen while establishing the database access or committing
@@ -608,10 +604,6 @@ extension DatabaseWriter {
608604
/// execution of the closure. Do not store or return the database connection
609605
/// for later use.
610606
///
611-
/// It is a programmer error to call this method from another database
612-
/// access method. Doing so raises a "Database methods are not reentrant"
613-
/// fatal error at runtime.
614-
///
615607
/// - warning: Database operations are not wrapped in a transaction. They
616608
/// can see changes performed by concurrent writes or writes performed by
617609
/// other processes: two identical requests performed by the `updates`

GRDB/Core/SQLRequest.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
/// }
2121
/// ```
2222
///
23-
/// An `SQLRequest` can be created from a string literal, as in the above
24-
/// example, or from one of the initializers documented below.
23+
/// An `SQLRequest` can be created from a string literal or interpolation, as in
24+
/// the above examples, and from the initializers documented below.
2525
///
2626
/// ## Topics
2727
///

GRDB/Documentation.docc/DatabaseSchema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Learn how to define the database schema.
44

55
## Overview
66

7-
SQLite directly supports a [set of schema alterations](https://www.sqlite.org/lang.html). Many of them are available as `Database` methods such as ``Database/create(table:options:body:)``, ``Database/alter(table:body:)``, listed below.
7+
SQLite directly supports a [set of schema alterations](https://www.sqlite.org/lang.html). Many of them are available as Swift methods such as ``Database/create(table:options:body:)``, ``Database/alter(table:body:)``, listed below.
88

99
You can directly create tables when you open a database, as below:
1010

0 commit comments

Comments
 (0)