Skip to content

Commit d40db32

Browse files
committed
modified docstrings in record_ciphertext.rs and record_plaintext.rs modules
1 parent c1b803a commit d40db32

File tree

3 files changed

+8
-12
lines changed

3 files changed

+8
-12
lines changed

docs/api_reference/sdk-src_wasm.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2930,12 +2930,11 @@ __*return*__ | [Group](sdk-src_wasm.md) | *The record nonce.*
29302930
29312931
![modifier: public](images/badges/modifier-public.svg)
29322932
2933-
Clone the record ciphertext.
2933+
Clone the RecordCiphertext WASM object.
29342934
29352935
Parameters | Type | Description
29362936
--- | --- | ---
2937-
__*return*__ | [RecordCiphertext](sdk-src_wasm.md) | *A clone of the record ciphertext.
2938-
Clone the field element.*
2937+
__*return*__ | [RecordCiphertext](sdk-src_wasm.md) | *A clone of the RecordCiphertext WASM object.*
29392938
29402939
---
29412940
@@ -3177,12 +3176,11 @@ __*return*__ | [Group](sdk-src_wasm.md) | *record view key*
31773176
31783177
![modifier: public](images/badges/modifier-public.svg)
31793178
3180-
Clone the record plaintext.
3179+
Clone the RecordPlaintext WASM object.
31813180
31823181
Parameters | Type | Description
31833182
--- | --- | ---
3184-
__*return*__ | [RecordPlaintext](sdk-src_wasm.md) | *A clone of the record plaintext.
3185-
Clone the field element.*
3183+
__*return*__ | [RecordPlaintext](sdk-src_wasm.md) | *A clone of the RecordPlaintext WASM object.*
31863184
31873185
---
31883186

wasm/src/record/record_ciphertext.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,9 @@ impl RecordCiphertext {
157157
Group::from(self.0.nonce())
158158
}
159159

160-
/// Clone the record ciphertext.
160+
/// Clone the RecordCiphertext WASM object.
161161
///
162-
/// @returns {RecordCiphertext} A clone of the record ciphertext.
163-
/// Clone the field element.
162+
/// @returns {RecordCiphertext} A clone of the RecordCiphertext WASM object.
164163
#[allow(clippy::should_implement_trait)]
165164
pub fn clone(&self) -> RecordCiphertext {
166165
RecordCiphertext(self.0.clone())

wasm/src/record/record_plaintext.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -266,10 +266,9 @@ impl RecordPlaintext {
266266
Group::from_string(&self.nonce()).unwrap().scalar_multiply(&view_key.to_scalar()).to_x_coordinate()
267267
}
268268

269-
/// Clone the record plaintext.
269+
/// Clone the RecordPlaintext WASM object.
270270
///
271-
/// @returns {RecordPlaintext} A clone of the record plaintext.
272-
/// Clone the field element.
271+
/// @returns {RecordPlaintext} A clone of the RecordPlaintext WASM object.
273272
#[allow(clippy::should_implement_trait)]
274273
pub fn clone(&self) -> RecordPlaintext {
275274
RecordPlaintext(self.0.clone())

0 commit comments

Comments
 (0)