Clean up docstrings

This commit is contained in:
Marcus Kammer 2024-08-08 21:39:10 +02:00
parent 2dfd058a11
commit 07c880c40a
Signed by: marcuskammer
GPG key ID: C374817BE285268F

View file

@ -20,7 +20,7 @@
If CONTENT is a number, format it to 9 decimal places. If CONTENT is a number, format it to 9 decimal places.
Otherwise, return CONTENT as-is (Spinneret will handle escaping). Otherwise, return CONTENT as-is (Spinneret will handle escaping).
- CONTENT: The cell content (can be a number or any other type) CONTENT: The cell content (can be a number or any other type)
Returns: Returns:
- If CONTENT is a number, a string representation with 9 decimal places. - If CONTENT is a number, a string representation with 9 decimal places.
@ -32,7 +32,7 @@ Returns:
(defun render-tbl-header (headers) (defun render-tbl-header (headers)
"Render the header of an HTML table using Spinneret. "Render the header of an HTML table using Spinneret.
- HEADERS: A list of header cell contents HEADERS: A list of header cell contents
Example: Example:
(render-tbl-header '(\"Name\" \"Age\" \"City\"))" (render-tbl-header '(\"Name\" \"Age\" \"City\"))"
@ -45,7 +45,7 @@ Example:
(defun render-tbl-body (rows) (defun render-tbl-body (rows)
"Render the body of an HTML table using Spinneret. "Render the body of an HTML table using Spinneret.
- ROWS: A list of rows, where each row is a list of cell contents ROWS: A list of rows, where each row is a list of cell contents
Example: Example:
(render-tbl-body '((\"John\" 30 \"New York\") (\"Jane\" 25 \"San Francisco\")))" (render-tbl-body '((\"John\" 30 \"New York\") (\"Jane\" 25 \"San Francisco\")))"
@ -59,9 +59,9 @@ Example:
(defun render-tbl (headers rows &key (class "table")) (defun render-tbl (headers rows &key (class "table"))
"Render a complete HTML table using Spinneret. "Render a complete HTML table using Spinneret.
- HEADERS: A list of header cell contents HEADERS: A list of header cell contents
- ROWS: A list of rows, where each row is a list of cell contents ROWS: A list of rows, where each row is a list of cell contents
- CLASS: CSS class for the table (default: \"table\") CLASS: CSS class for the table (default: \"table\")
Example: Example:
(render-tbl '(\"Name\" \"Age\" \"City\") (render-tbl '(\"Name\" \"Age\" \"City\")