Skip to content

Commit 543d4b7

Browse files
committed
docs: fix lint errors
1 parent b60a1f8 commit 543d4b7

File tree

4 files changed

+2
-9
lines changed

4 files changed

+2
-9
lines changed

src/model/collection/periodic-notes.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,9 @@ export type PeriodicNotesConfig<IsValidConfiguration extends boolean> =
112112
*
113113
* If any of these validations fail, an {@link AggregateError} is thrown detailing all issues.
114114
* Otherwise, it returns a new configuration object with more specific types.
115-
*
116115
* @param config - The configuration object to validate.
117116
* @returns A validated configuration with strictly defined properties.
118-
*
119-
* @throws {AggregateError} If one or more properties of the configuration are invalid.
117+
* @throws If one or more properties of the configuration are invalid.
120118
*/
121119
function validated(config: PeriodicNotesConfig<false>): PeriodicNotesConfig<true> {
122120
const folder = stripTrailingSlash(config.folder);

src/model/collection/util.ts

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
* Returns a sanitized folder path by removing a trailing slash unless the path is the root ("/").
33
*
44
* The function trims whitespace from the input folder string. If the trimmed string equals "/", it is returned unchanged. Otherwise, any trailing slash is removed.
5-
*
65
* @param folder - The folder path to sanitize.
76
* @returns The folder path without a trailing slash, except for the root path.
87
*/

src/model/task/util.ts

-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ import { DEFAULT_PRIORITY_VALUE, DEFAULT_TYPE_VALUE, Task, TASK_WITH_DEFAULT_VAL
66

77
/**
88
* Merges multiple partial Task objects into a complete Task using a custom merge strategy.
9-
*
109
* The function begins with default Task values and sequentially merges each provided partial Task. For each property, the front-most non-default value is retained. Special handling is applied for properties such as task type, priority, strings, DateTime objects, and Set collections.
11-
*
1210
* @param parts - The partial Task objects to merge.
1311
* @returns new {@link Task} with the front-most non-default values taken from the parts.
1412
*/

src/util/luxon-utils.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,9 @@ export type LuxonFormat = Brand<string, "LuxonFormat">;
1414
* This function checks whether a Luxon date, duration, or interval is valid. If the value is invalid,
1515
* it throws an error with a message combining a custom header (or default constructor name) with the
1616
* value's invalid reason and, if available, its invalid explanation.
17-
*
1817
* @param value - The Luxon object to validate.
1918
* @param message - Optional custom header for the error message.
20-
*
21-
* @throws {Error} If the provided value is invalid.
19+
* @throws If the provided value is invalid.
2220
*/
2321
export function assertValid(
2422
value: LuxonValue<true> | LuxonValue<false>,

0 commit comments

Comments
 (0)