Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc comment #335

Merged
merged 3 commits into from
Feb 7, 2020
Merged

Update doc comment #335

merged 3 commits into from
Feb 7, 2020

Conversation

NikVolf
Copy link
Contributor

@NikVolf NikVolf commented Feb 7, 2020

No description provided.

Co-Authored-By: Andronik Ordian <write@reusable.software>
@ordian
Copy link
Member

ordian commented Feb 7, 2020

diff --git a/parity-util-mem/src/malloc_size.rs b/parity-util-mem/src/malloc_size.rs
index 3bc9cc4..c68f8f6 100644
--- a/parity-util-mem/src/malloc_size.rs
+++ b/parity-util-mem/src/malloc_size.rs
@@ -588,12 +588,12 @@ impl<T: MallocSizeOf> MallocSizeOf for parking_lot::RwLock<T> {
 /// ```rust
 /// use parity_util_mem::{malloc_size, malloc_size_of_is_0};
 ///
-/// struct Data<T>(pub T)
+/// struct Data<T>(pub T);
 ///
 /// // generic argument (`T`) must be `impl MallocSizeOf`
 /// malloc_size_of_is_0!(Data<u8>);
 ///
-/// assert_eq!(malloc_size(&Data(0u8), 0);
+/// assert_eq!(malloc_size(&Data(0u8)), 0);
 /// ```
 #[macro_export]
 macro_rules! malloc_size_of_is_0(

@NikVolf
Copy link
Contributor Author

NikVolf commented Feb 7, 2020

diff --git a/parity-util-mem/src/malloc_size.rs b/parity-util-mem/src/malloc_size.rs
index 3bc9cc4..c68f8f6 100644
--- a/parity-util-mem/src/malloc_size.rs
+++ b/parity-util-mem/src/malloc_size.rs
@@ -588,12 +588,12 @@ impl<T: MallocSizeOf> MallocSizeOf for parking_lot::RwLock<T> {
 /// ```rust
 /// use parity_util_mem::{malloc_size, malloc_size_of_is_0};
 ///
-/// struct Data<T>(pub T)
+/// struct Data<T>(pub T);
 ///
 /// // generic argument (`T`) must be `impl MallocSizeOf`
 /// malloc_size_of_is_0!(Data<u8>);
 ///
-/// assert_eq!(malloc_size(&Data(0u8), 0);
+/// assert_eq!(malloc_size(&Data(0u8)), 0);
 /// ```
 #[macro_export]
 macro_rules! malloc_size_of_is_0(

Thanks, already updated :)

@ordian ordian merged commit 4c087c0 into master Feb 7, 2020
@ordian ordian deleted the nv-update-doc-comment branch February 7, 2020 16:50
dvdplm added a commit that referenced this pull request Feb 8, 2020
ordian added a commit that referenced this pull request Feb 11, 2020
* origin/master:
  [parity-crypto] prepare 0.5.0 (#336)
  [parity crypto]: remove unused depend `rustc_hex` (#337)
  Update doc comment (#335)
  Add different mode for malloc_size_of_is_0 macro dealing with generics (#334)
ordian added a commit that referenced this pull request Feb 13, 2020
* master:
  prepare rlp-derive release (#344)
  Update/change licenses: MIT/Apache2.0 (#342)
  rlp-derive extracted (#343)
  Format for readme and changelog corrected (#341)
  Parity runtime moved to parity common for publication in crates.io (#271)
  Disable cache if explicit memory budget=0 passed (#339)
  [parity-crypto] prepare 0.5.0 (#336)
  [parity crypto]: remove unused depend `rustc_hex` (#337)
  Update doc comment (#335)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants