docs(types): align module descriptions

haithium · haithium · commit b49527eb1831 · 2026-03-23T17:54:31.000+02:00
diff --git a/README.md b/README.md
@@ -47,25 +47,25 @@ luarocks install mods
 
 ## Modules
 
-| Module         | Description                                                         |
-| -------------- | ------------------------------------------------------------------- |
-| [`fs`]         | Filesystem I/O and metadata operations.                             |
-| [`is`]         | Type predicates for Lua values and filesystem path types.           |
-| [`keyword`]    | Lua keyword helpers.                                                |
-| [`List`]       | A list class with common sequence operations.                       |
-| [`ntpath`]     | Lexical path operations for Windows/NT-style paths.                 |
-| [`operator`]   | Operator helpers as functions.                                      |
-| [`path`]       | Generic cross-platform path API.                                    |
-| [`posixpath`]  | Lexical path operations for POSIX-style paths.                      |
-| [`repr`]       | Render any Lua value as a readable string.                          |
-| [`runtime`]    | Exposes Lua runtime metadata and version compatibility flags.       |
-| [`Set`]        | A set class with common operations on unique values.                |
-| [`str`]        | String utility helpers modeled after Python's `str`.                |
-| [`stringcase`] | String case conversion helpers.                                     |
-| [`tbl`]        | Utility functions for working with Lua tables.                      |
-| [`template`]   | Interpolate string placeholders of the form `{{...}}`.              |
-| [`utils`]      | Small shared utility helpers used by modules in this library.       |
-| [`validate`]   | Validation checks for values and filesystem path types.             |
+| Module         | Description                                                   |
+| -------------- | ------------------------------------------------------------- |
+| [`fs`]         | Filesystem I/O, metadata, and filesystem path operations.    |
+| [`is`]         | Type predicates for Lua values and filesystem path types.     |
+| [`keyword`]    | Helpers for Lua keywords and identifiers.                     |
+| [`List`]       | A list class for creating, transforming, and querying sequences of values. |
+| [`ntpath`]     | Windows/NT-style path operations.                             |
+| [`operator`]   | Lua operators exposed as functions.                           |
+| [`path`]       | Cross-platform path operations with host-platform semantics.  |
+| [`posixpath`]  | POSIX-style path operations.                                  |
+| [`repr`]       | Readable string rendering for Lua values.                     |
+| [`runtime`]    | Lua runtime metadata and version compatibility flags.         |
+| [`Set`]        | A set class for creating, combining, and querying unique values. |
+| [`str`]        | String operations for searching, splitting, trimming, and formatting text. |
+| [`stringcase`] | String case conversion and word splitting.                    |
+| [`tbl`]        | Table operations for querying, copying, merging, and transforming tables. |
+| [`template`]   | String template rendering with `{{...}}` placeholders.        |
+| [`utils`]      | Shared utility helpers used across the Mods library.          |
+| [`validate`]   | Validation helpers for Lua values and filesystem path types.  |
 
 > [!NOTE]
 >
diff --git a/types/List.lua b/types/List.lua
@@ -1,8 +1,7 @@
 ---@meta mods.List
 
 ---
----A list class providing common operations to create,
----modify, and query sequences of values.
+---A list class for creating, transforming, and querying sequences of values.
 ---
 ---## Usage
 ---
diff --git a/types/Set.lua b/types/Set.lua
@@ -1,8 +1,7 @@
 ---@meta mods.Set
 
 ---
----A set class providing common operations to create, modify, and query
----collections of unique values.
+---A set class for creating, combining, and querying unique values.
 ---
 ---## Usage
 ---
diff --git a/types/fs.lua b/types/fs.lua
@@ -1,7 +1,7 @@
 ---@meta mods.fs
 
 ---
----Filesystem, environment, and cwd-dependent path operations.
+---Filesystem I/O, metadata, and filesystem path operations.
 ---
 ---## Usage
 ---
diff --git a/types/keyword.lua b/types/keyword.lua
@@ -1,7 +1,7 @@
 ---@meta mods.keyword
 
 ---
----Lua keyword helpers.
+---Helpers for Lua keywords and identifiers.
 ---
 ---## Usage
 ---
diff --git a/types/ntpath.lua b/types/ntpath.lua
@@ -1,6 +1,6 @@
 ---@meta mods.ntpath
 
----Path operations for Windows/NT-style paths.
+---Windows/NT-style path operations.
 ---
 --->💡Python `ntpath`-style behavior, ported to Lua.
 ---
diff --git a/types/operator.lua b/types/operator.lua
@@ -1,7 +1,7 @@
 ---@meta mods.operator
 
 ---
----Operator helpers as functions.
+---Lua operators exposed as functions.
 ---
 ---## Usage
 ---
diff --git a/types/path.lua b/types/path.lua
@@ -1,7 +1,7 @@
 ---@meta mods.path
 
 ---
----Generic cross-platform path API with host-platform semantics.
+---Cross-platform path operations with host-platform semantics.
 ---
 ---## Usage
 ---
diff --git a/types/posixpath.lua b/types/posixpath.lua
@@ -1,7 +1,7 @@
 ---@meta mods.posixpath
 
 ---
----Path operations for POSIX-style paths.
+---POSIX-style path operations.
 ---
 --->💡 Python `posixpath`-style behavior, ported to Lua.
 ---
diff --git a/types/repr.lua b/types/repr.lua
@@ -1,6 +1,6 @@
 ---@meta mods.repr
 ---
----Render any Lua value as a readable string.
+---Readable string rendering for Lua values.
 ---
 ---## Usage
 ---
diff --git a/types/runtime.lua b/types/runtime.lua
@@ -1,7 +1,7 @@
 ---@meta mods.runtime
 
 ---
----Exposes Lua runtime metadata and version compatibility flags.
+---Lua runtime metadata and version compatibility flags.
 ---
 ---## Usage
 ---
diff --git a/types/str.lua b/types/str.lua
@@ -1,7 +1,7 @@
 ---@meta mods.str
 
 ---
----String utility helpers modeled after Python's `str`.
+---String operations for searching, splitting, trimming, and formatting text.
 ---
 ---## Usage
 ---
diff --git a/types/stringcase.lua b/types/stringcase.lua
@@ -1,7 +1,7 @@
 ---@meta mods.stringcase
 
 ---
----String case conversion helpers.
+---String case conversion and word splitting.
 ---
 ---## Usage
 ---
diff --git a/types/tbl.lua b/types/tbl.lua
@@ -1,7 +1,7 @@
 ---@meta mods.tbl
 
 ---
----Utility functions for working with Lua tables.
+---Table operations for querying, copying, merging, and transforming tables.
 ---
 ---## Usage
 ---
diff --git a/types/template.lua b/types/template.lua
@@ -1,6 +1,6 @@
 ---@meta mods.template
 ---
----Interpolate string placeholders of the form <code v-pre>{{...}}</code>.
+---String template rendering with <code v-pre>{{...}}</code> placeholders.
 ---
 ---## Usage
 ---
diff --git a/types/utils.lua b/types/utils.lua
@@ -1,7 +1,7 @@
 ---@meta mods.utils
 
 ---
----Small shared utility helpers used by modules in this library.
+---Shared utility helpers used across the Mods library.
 ---
 ---## Usage
 ---
diff --git a/types/validate.lua b/types/validate.lua
@@ -30,7 +30,7 @@
 ---@field socket? string
 
 ---
----Validation checks for values and filesystem path types.
+---Validation helpers for Lua values and filesystem path types.
 ---
 ---## Usage
 ---
