CooMatrix::reserve added #885
Conversation
There was a problem hiding this comment.
Thanks for this PR, @chammika-become! Looks good to me, and exactly as intended in #881. I only noticed a couple of very minor grammatical things in the doc comments (I hope I got it correct myself, my English is not flawless).
I think the docs would definitely benefit from some additional doc tests, yes! Would be happy to see additional PRs if you would like to work on this :)
nalgebra-sparse/src/coo.rs
Outdated
| /// Reserves capacity for COO matrix by at least `additional` elements. | ||
| /// | ||
| /// This increase the capacities of triplet holding arrays by reserving more space to avoid | ||
| /// frequent reallocations, in `push` operations. |
There was a problem hiding this comment.
maybe remove the comma here? ("... frequent reallocations in push operations)
nalgebra-sparse/src/coo.rs
Outdated
| /// | ||
| /// ## Panics | ||
| /// | ||
| /// Panics if any of the individual allocation of triplet arrays fail. |
There was a problem hiding this comment.
Perhaps "Panics if any of the individual allocations of triplet arrays fails."
nalgebra-sparse/src/coo.rs
Outdated
| /// ``` | ||
| /// # use nalgebra_sparse::coo::CooMatrix; | ||
| /// let mut coo = CooMatrix::new(4, 4); | ||
| /// // Reserver capacity in advance |
There was a problem hiding this comment.
Reserver -> Reserve?
|
Thank you for the corrections. I will pay more attention to grammar next time. |
|
No worries, as I said they were super minor, and it wouldn't really have been necessary to fix them either, because the meaning was clear. I just prefer fixing them up front, because nobody will bother to fix it later! |
|
Thanks! |
PR for #881
Note: I've noticed missing doc-tests in some of the APIs. Can add them in future PRs if it helps the documentation.