Added recommended syntax for the options array (#28)

* Added recommended syntax for the options array

* Use more formal words

* Added changelog

Author: Nyholm

Changelog.md

@@ -2,10 +2,14 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 3.0.1
+
+Added comments on the `TransferableStorage` interface to describe the options parameter.
+
 ## 3.0.0
 
 Allowing `Storage::get()` to return null. This has always been the intention but 2.0.0 was tagged with a bug
-that could only be corrected with a BC break. 
+that could only be corrected with a BC break.
 
 ## 2.0.0
 

src/TransferableStorage.php

@@ -22,13 +22,21 @@ interface TransferableStorage
 {
     /**
      * Get messages from the storage into the $catalogue.
+     *
+     * @var array a list of arbitrary options that could be used. The array SHOULD
+     *            use a format of array<string, array<mixed $value>.
+     *            Example: ['foo' => ['bar', 'baz]]
      */
     public function export(MessageCatalogueInterface $catalogue, array $options = []): void;
 
     /**
      * Populate the storage with all the messages in $catalogue. This action
      * should be considered as a "force merge". Existing messages in the storage
      * will be overwritten but no message will be removed.
+     *
+     * @var array a list of arbitrary options that could be used. The array SHOULD
+     *            use a format of array<string, array<mixed $value>.
+     *            Example: ['foo' => ['bar', 'baz]]
      */
     public function import(MessageCatalogueInterface $catalogue, array $options = []): void;
 }