add some docs

HalaOS · Feb 24, 2024 · cc75f8a · cc75f8a
1 parent b08e30a
commit cc75f8a
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 182 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
diff --git a/.vscode/launch.json b/.vscode/launch.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/Cargo.toml b/Cargo.toml
@@ -83,6 +83,3 @@ hala-tls = {path = "crates/net/tls", version = "^0.1"}
 hala-udp = {path = "crates/net/udp", version = "^0.1"}
 
 hala-rs = {path = "hala", version = "^0.1"}
-
-[profile.release]
-debug = 1
diff --git a/README.md b/README.md
@@ -5,4 +5,4 @@
 [!["Crates.io version"](https://img.shields.io/crates/v/hala-rs.svg)](https://crates.io/crates/hala-rs)
 [!["docs.rs docs"](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/hala-rs)
 
-hala std library for rust programming.
+Core crates for developing Hala rust applications.
diff --git a/crates/net/tcp/src/listener.rs b/crates/net/tcp/src/listener.rs
@@ -24,7 +24,12 @@ impl Debug for TcpListener {
 }
 
 impl TcpListener {
-    /// Create new tcp listener with calling underly bind method.
+    /// Create new `TcpListener` which will be bound to the specified `laddrs`
+    ///
+    /// The returned listener is ready for accepting connections.
+    ///
+    /// Binding with a port number of 0 will request that the OS assigns a port to this listener.
+    /// The port allocated can be queried via the [`local_addr`](TcpListener::local_addr) method.
     pub fn bind<S: ToSocketAddrs>(laddrs: S) -> io::Result<Self> {
         let io_context = io_context();
 

diff --git a/crates/test/Cargo.toml b/crates/test/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-description = "Hala test derive crate"
+description = "Proc macros for hala test"
 documentation = "https://docs.rs/hala-test"
 edition.workspace = true
 license = "MIT"