added documentations and change log for hash methods

amirreza8002 · Dec 17, 2024 · c295f5f · c295f5f
1 parent f61f3f9
commit c295f5f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,3 +1,13 @@
+Version 1.0.0
+-------------
+
+Breaking change:
+- floats are no longer serialized when passing to valkey (in theory shouldn't break anything)
+
+New features:
+- Added the missing hash methods, now all hash methods are supported except for ``hmset`` which is deprecated.
+- hset: added ``mapping`` and ``items`` parameters for bulk operations.
+
 Version 0.1.8
 -------------
 

diff --git a/docs/source/migration.rst b/docs/source/migration.rst
@@ -11,6 +11,10 @@ Install django-valkey
 As explained in :doc:`installation` you can easily install django-valkey.
 this project can easily live alongside django-redis so you don't need to delete that if you don't want to.
 
+Different behaviour
+###################
+
+in django-redis floats are serialized when being passed to redis, as of 1.0.0 django-valkey does not serialize floats to support atomic float operations, in theory this doesn't break anything since the return value does not change.
 
 Different configuration
 #######################
@@ -47,3 +51,8 @@ More options
 
 Although the above steps are completely enough to get you going, if you want you can now easily customize your compression behaviour.
 Check out :doc:`configure/compressors` for complete explanation.
+
+More methods
+############
+
+as of 1.0.0 every hash operation is supported.