(opendal) 02/03: add docs

[ti...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tison pushed a commit to branch unify-range-bounds
in repository https://gitbox.apache.org/repos/asf/opendal.git

commit 3b8b78062fd6e45ef05b6f52a08380c41ec152dc
Author: tison <wa...@gmail.com>
AuthorDate: Thu Jun 6 08:44:34 2024 +0800

    add docs
    
    Signed-off-by: tison <wa...@gmail.com>
---
 core/src/docs/upgrade.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/core/src/docs/upgrade.md b/core/src/docs/upgrade.md
index b4f35b81f3..0c75fb83d1 100644
--- a/core/src/docs/upgrade.md
+++ b/core/src/docs/upgrade.md
@@ -1,3 +1,24 @@
+# Upgrade to v0.47
+
+## Public API
+
+### BytesRange now always has a size
+
+Since 0.47, the signature of `BytesRange` changed from:
+
+```rust
+pub struct BytesRange(u64, Option<u64>);
+```
+
+to:
+
+````rust
+pub struct BytesRange {
+    offset: u64,
+    size: u64,
+}
+````
+
 # Upgrade to v0.46
 
 ## Public API