feat: docs

pointfreeco · Oct 6, 2024 · aecaede · aecaede
1 parent f3aa460
commit aecaede
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git 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
@@ -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.