Skip to content

Commit

Permalink
docs(objectarium): mention already stored new behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
amimart committed Apr 6, 2024
1 parent 7e56d22 commit 45a565c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion contracts/okp4-objectarium/src/msg.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pub enum ExecuteMsg {
/// # StoreObject
/// StoreObject store an object to the bucket and make the sender the owner of the object.
/// The object is referenced by the hash of its content and this value is returned.
/// If the object is already stored, an error is returned.
/// If the object is already stored, it is a no-op. It may be pinned though.
///
/// The "pin" parameter specifies if the object should be pinned for the sender. In such case,
/// the object cannot be removed (forget) from the storage.
Expand Down
4 changes: 2 additions & 2 deletions docs/okp4-objectarium.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Execute messages

### ExecuteMsg::StoreObject

StoreObject store an object to the bucket and make the sender the owner of the object. The object is referenced by the hash of its content and this value is returned. If the object is already stored, an error is returned.
StoreObject store an object to the bucket and make the sender the owner of the object. The object is referenced by the hash of its content and this value is returned. If the object is already stored, it is a no-op. It may be pinned though.

The "pin" parameter specifies if the object should be pinned for the sender. In such case, the object cannot be removed (forget) from the storage.

Expand Down Expand Up @@ -511,4 +511,4 @@ A string containing a 128-bit integer in decimal representation.

---

_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`8f8fd1b1c8982ddb`)_
_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`dbf16753cc3b0930`)_

0 comments on commit 45a565c

Please sign in to comment.