examples, docs, version

Author: radumarias

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "zeroize"
-version = "0.1.6"
+version = "0.1.7"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -11,8 +11,8 @@ It uses [zeroize](https://crates.io/crates/zeroize) crate under the hood.
 It can work with `bytearray` and `numpy array`.
 
 > [!WARNING]
-> **In the case of [Copy-on-write fork](https://en.wikipedia.org/wiki/Copy-on-write) you should zeroize the memory before fork the child process, see example below.  
-> Also by itself it doesn't work if memory is moved or moved to swap file. You can use `crypes` with `libc.mlock()` to lock the memory, see example below.**
+> **In the case of [Copy-on-write fork](https://en.wikipedia.org/wiki/Copy-on-write) you need to zeroize the memory before forking the child process, see example below.  
+> Also by itself it doesn't work if memory is moved or moved to swap. You can use `crypes` with `libc.mlock()` to lock the memory, see example below.**
 
 # Examples
 

README.md

@@ -1,3 +1,5 @@
+"""By itself it doesn't work if memory is moved or moved to swap. You can use `crypes` with `libc.mlock()` to lock the memory"""
+
 from zeroize import zeroize1, zeroize_np
 import numpy as np
 import ctypes

examples/lock_and_zeroize.py

@@ -1,6 +1,7 @@
+""" In the case of [Copy-on-write fork](https://en.wikipedia.org/wiki/Copy-on-write) you need to zeroize the memory before forking the child process. """
+
 import os
-from zeroize import zeroize1, zeroize_np
-import numpy as np
+from zeroize import zeroize1
 import ctypes
 
 
@@ -51,4 +52,3 @@ def unlock_memory(buffer):
     # Unlock the memory
     print("unlocking memory")
     unlock_memory(sensitive_data)
-