diff --git a/Sources/SnapshotTesting/Documentation.docc/Articles/ImageSerializationPlugin.md b/Sources/SnapshotTesting/Documentation.docc/Articles/ImageSerializationPlugin.md index e9268a7d..a29aa9fa 100644 --- a/Sources/SnapshotTesting/Documentation.docc/Articles/ImageSerializationPlugin.md +++ b/Sources/SnapshotTesting/Documentation.docc/Articles/ImageSerializationPlugin.md @@ -75,7 +75,7 @@ For example, if you want to use JPEG XL as a new image format for your snapshots ``` > [!IMPORTANT] -> On **non** Apple platform you will need to call `PluginRegistry.registerPlugin(YourPlugin.init()))` to register it. +> On **non** Apple platform you will need to call `PluginRegistry.registerPlugin(YourPlugin.init())` to register it. Alternatively, you can specify the image format for individual assertions: diff --git a/Sources/SnapshotTesting/Documentation.docc/Articles/Plugins.md b/Sources/SnapshotTesting/Documentation.docc/Articles/Plugins.md index 21e133c8..529e2fcd 100644 --- a/Sources/SnapshotTesting/Documentation.docc/Articles/Plugins.md +++ b/Sources/SnapshotTesting/Documentation.docc/Articles/Plugins.md @@ -16,4 +16,7 @@ The primary components of the plugin system include: - **PluginRegistry**: Manages plugin discovery, registration, and retrieval. - **Objective-C Runtime Integration**: Allows automatic discovery of plugins that conform to specific protocols. +> [!IMPORTANT] +> On **non** Apple platform you will need to call `PluginRegistry.registerPlugin(YourPlugin.init())` to register your plugin. + The `PluginRegistry` is a singleton that registers plugins during its initialization. Plugins can be retrieved by their identifier or cast to specific types, allowing flexible interaction.