@shd101wyy/yo 0.1.12 → 0.1.13

package/std/url/index.yo

@@ -1,28 +1,11 @@
-// std/url - URL parsing and formatting
-//
-// Parse, manipulate, and format URLs per RFC 3986 (simplified).
-//
-// Example:
-//   { Url, UrlError } :: import "std/url";
-//
-//   url := Url.parse("https://example.com:8080/path?q=1#frag").unwrap();
-//   assert(url.scheme() == `https`);
-//   assert(url.host() == .Some(`example.com`));
-//   assert(url.port() == .Some(u16(8080)));
-//   assert(url.path() == `/path`));
-//   assert(url.query() == .Some(`q=1`));
-//   assert(url.fragment() == .Some(`frag`));
-//   println(url.to_string());  // "https://example.com:8080/path?q=1#frag"
+//! URL parsing and formatting per RFC 3986 (simplified).
 
 open import "../string";
 { ArrayList } :: import "../collections/array_list";
 { ToString } :: import "../fmt";
 { Error, AnyError, Exception } :: import "../error";
 
-// ============================================================================
-// UrlError
-// ============================================================================
-
+/// Errors that can occur during URL parsing.
 UrlError :: enum(
   EmptyInput,
   MissingScheme,
@@ -101,6 +84,7 @@ _parse_port :: (fn(s: str, start: usize, end: usize, using(exn : Exception)) ->
   u16(val)
 });
 
+/// Parsed URL with scheme, host, port, path, query, and fragment components.
 Url :: object(
   _scheme   : String,
   _host     : Option(String),

package/std/worker.yo

@@ -1,13 +1,7 @@
-// Worker - Thread Pool with Thread Affinity
-// ==========================================
-// Worker spawns tasks on a thread pool. Each task has thread affinity:
-// tasks are distributed round-robin to worker threads and stay on their
-// assigned thread (no work stealing).
-//
-// Thread-per-core: By default, one worker thread per CPU core.
-// Thread affinity: Each task runs on a specific worker thread.
-// Thread-local GC: Each worker thread has its own GC heap.
-// Per-thread IO: Each worker thread has its own async event loop, shared by all tasks on that thread.
+//! Thread pool with per-core thread affinity and round-robin task distribution.
+//!
+//! Each task is pinned to a worker thread (no work stealing).
+//! Each worker thread has its own GC heap and async IO event loop.
 
 extern "Yo",
   __yo_worker_spawn : (fn(cb : Impl(Fn(using(io : IO)) -> unit, Send)) -> unit),
@@ -15,22 +9,20 @@ extern "Yo",
   __yo_worker_set_num_threads : (fn(num: usize) -> unit)
 ;
 
-// Spawn a task on the thread pool.
-// Returns immediately, task runs in background.
-// Tasks are distributed round-robin to worker threads.
-// The closure receives the worker thread's IO event loop.
+/// Spawn a task on the thread pool. Returns immediately; the task runs in the background.
+/// Tasks are distributed round-robin to worker threads.
 spawn :: (fn(cb : Impl(Fn(using(io : IO)) -> unit, Send)) -> unit)({
   __yo_worker_spawn(cb);
 });
 
-// Get number of threads in pool.
-// Default: number of hardware threads (CPU cores).
+/// Get the number of worker threads in the pool.
+/// Defaults to the number of hardware threads (CPU cores).
 get_num_threads :: (fn() -> usize)(
   __yo_worker_get_num_threads()
 );
 
-// Configure thread pool size.
-// Must be called before first spawn to take effect.
+/// Set the number of worker threads in the pool.
+/// Must be called before the first `spawn` to take effect.
 set_num_threads :: (fn(num: usize) -> unit)(
   __yo_worker_set_num_threads(num)
 );