tisonkun commented on code in PR #1:
URL: https://github.com/apache/datasketches-rust/pull/1#discussion_r2617142770
##########
src/lib.rs:
##########
@@ -15,17 +15,8 @@
// specific language governing permissions and limitations
// under the License.
-pub fn add(left: u64, right: u64) -> u64 {
- left + right
-}
+#![doc = include_str!("../README.md")]
Review Comment:
```suggestion
//! # Apache® DataSketches™ Core Rust Library Component
//!
//! The Sketching Core Library provides a range of stochastic streaming
algorithms and closely
//! related Rust technologies that are particularly useful when integrating
this technology into
//! systems that must deal with massive data.
//!
//! This library is divided into modules that constitute distinct groups of
functionality.
```
The README is rendered improperly on docs.rs:
<img width="1980" height="1384" alt="Image"
src="https://github.com/user-attachments/assets/5b8d5b72-5300-4791-80a7-d2117d970374";
/>
I borrowed this lib doc from
https://apache.github.io/datasketches-java/8.0.0/, and we can improve it with
better outlines when we implement more sketches.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
