Skip to content

Commit 89592fd

Browse files
committed
chore: cleanup doc comments
1 parent 0530a5a commit 89592fd

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

src/lib/dependency_graph.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export class DependencyGraph {
127127
* Delegates to `@fuzdev/fuz_util/sort.js` for the sorting algorithm.
128128
* Throws if cycles detected.
129129
*
130-
* @param exclude_dev - If true, excludes dev dependencies to break cycles.
130+
* @param exclude_dev - if true, excludes dev dependencies to break cycles
131131
* Publishing uses exclude_dev=true to handle circular dev deps.
132132
* @returns array of package names in dependency order (dependencies before dependents)
133133
* @throws {Error} if circular dependencies detected in included dependency types

src/lib/fetch_repo_data.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import type {LocalRepo} from './local_repo.js';
1919
*
2020
* @param delay - milliseconds between API requests (default: 33ms)
2121
* @param cache - optional cache from fuz_util's fetch.js for response memoization
22-
* @returns array of Repo objects with GitHub metadata attached
22+
* @returns array of `Repo` objects with GitHub metadata attached
2323
*/
2424
export const fetch_repo_data = async (
2525
resolved_repos: Array<LocalRepo>,

src/routes/library.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@
545545
{
546546
"name": "exclude_dev",
547547
"type": "boolean",
548-
"description": "If true, excludes dev dependencies to break cycles.\nPublishing uses exclude_dev=true to handle circular dev deps.",
548+
"description": "if true, excludes dev dependencies to break cycles\nPublishing uses exclude_dev=true to handle circular dev deps.",
549549
"default_value": "false"
550550
}
551551
],
@@ -784,7 +784,7 @@
784784
"source_line": 24,
785785
"type_signature": "(resolved_repos: LocalRepo[], token?: string | undefined, cache?: Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | undefined, log?: Logger | undefined, delay?: number, github_api_version?: string | undefined): Promise<...>",
786786
"return_type": "Promise<RepoJson[]>",
787-
"return_description": "array of Repo objects with GitHub metadata attached",
787+
"return_description": "array of `Repo` objects with GitHub metadata attached",
788788
"parameters": [
789789
{
790790
"name": "resolved_repos",

0 commit comments

Comments
 (0)