Update doc and changelog

arokettu · Oct 4, 2020 · 0f1658d · 0f1658d
1 parent 1d693ff
commit 0f1658d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.3.0
+*Oct 4, 2020*
+
+* Shorten `dictionaryType` to `dictType`. `dictionaryType` will be removed in 3.0
+* Trigger silent deprecations for deprecated stuff
+
 ## 2.2.0
 
 *Oct 3, 2020*

diff --git a/docs/main.rst b/docs/main.rst
@@ -120,13 +120,15 @@ Decoding
     // You can control lists and dictionaries types with options
     $data = Bencode::decode(
         "...",
-        dictionaryType: ArrayObject::class, // pass class name, new $type($array) will be created
-        listType:       function ($array) { // or callback for greater flexibility
+        dictType: ArrayObject::class, // pass class name, new $type($array) will be created
+        listType: function ($array) { // or callback for greater flexibility
             return new ArrayObject($array, ArrayObject::ARRAY_AS_PROPS);
         },
     ]);
     // default value for both types is 'array'. you can also use 'object' for stdClass
 
+.. note:: Parameter order is not guaranteed for options, use named parameters
+
 Working with files
 ==================