📝 Add docstrings to docs (#61)

* 📝 Add docstrings to `docs`

Docstrings generation was requested by @brianrodri.

* #60 (comment)

The following files were modified:

* `src/model/task/lib/obsidian-tasks.ts`
* `src/util/luxon-utils.ts`

* Update src/util/luxon-utils.ts

* Update src/model/task/lib/obsidian-tasks.ts

* Update src/util/luxon-utils.ts

* Update src/model/task/lib/obsidian-tasks.ts

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Brian Rodriguez <[email protected]>

Author: coderabbitai[bot]

src/model/task/lib/obsidian-tasks.ts

@@ -7,18 +7,24 @@ import { Task } from "@/model/task/schema";
 import { SYMBOL_PATH_LOOKUP, SYMBOL_PRIORITY_LOOKUP, SYMBOL_REG_EXP } from "./obsidian-tasks.const";
 
 /**
- * Parses {@link Task} metadata from a real markdown blob using Obsidian Task's emoji format.
+ * Parses task metadata from a markdown string using Obsidian Task's emoji format.
  *
- * Here's an illustration:
- * ```
- * //                                                                      ( symbol & value )
- * "the text at the front is assumed to be a description. ❌ cancelled date ➕ creation date ✅ completed date"
- * //                                                    ( symbol & value  )                ( symbol & value  )
+ * The function extracts the task description (the text preceding the first emoji symbol) and associated metadata.
+ * Recognized emoji markers denote fields such as cancellation, creation, completion dates, priority, or dependencies.
  *
- * { cancelled: "cancelled date", created: "creation date", done: "completed date" }
+ * For example:
+ * ```
+ * "Prepare slides ❌ 2025-05-01 ➕ 2025-04-20 ✅ 2025-05-05"
+ * // Returns an object similar to:
+ * // {
+ * //   description: "Prepare slides",
+ * //   cancelled: DateTime for "2025-05-01",
+ * //   created: DateTime for "2025-04-20",
+ * //   done: DateTime for "2025-05-05"
+ * // }
  * ```
- * @param text - the text of the task without its' markdown text.
- * @returns a {@link Task} with the parsed metadata.
+ * @param text - The markdown text containing the task description and metadata formatted with Obsidian Task's emoji syntax.
+ * @returns A partial {@link Task} object populated with the extracted metadata.
  * @see {@link https://publish.obsidian.md/tasks/Reference/Task+Formats/Tasks+Emoji+Format}
  */
 export function parseTaskEmojiFormat(text: string): DeepPartial<Task> {

src/util/luxon-utils.ts

@@ -28,9 +28,16 @@ export function assertValidLuxonValue(
 }
 
 /**
- * @param dateFormat - the format to check.
- * @param dateOptions - the options to use when parsing and formatting.
+ * Asserts that the provided date format yields consistent results when formatting and parsing a date.
+ *
+ * This function formats a fixed UTC reference date into a string using the given format and optional options,
+ * then parses that string back into a date. It verifies that the parsed date is valid and that reformatting it
+ * produces the original string. Failing this consistency check triggers an error, indicating that the format is invalid
+ * for round-trip date conversions.
+ * @param dateFormat - The date format string to validate.
+ * @param dateOptions - Optional formatting and parsing options for date-time operations.
  * @see {@link https://moment.github.io/luxon/#/parsing?id=table-of-tokens}
+ * @throws If the date format does not produce matching formatted strings upon parsing.
  */
 export function assertValidDateTimeFormat(
     dateFormat: string,