Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds warning for missing function description in jsdocs generator #49

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds warning for missing function description in jsdocs generator #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/generators/jsdocs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { Schema } from "untyped";
import { titleCase } from "scule";
import consola from "consola";
import { defineGenerator } from "../generator";
import { resolvePath } from "../_utils";

Expand Down Expand Up @@ -104,6 +105,10 @@ function _renderSection(
if (schema.type === "function") {
// Function signature in heading
heading = `\`${_generateFunctionSig(key, schema)}\``;

if (!schema.description) {
consola.warn(`No description found in function ${heading}`);
}
} else if (schema.type !== "object") {
// JS value
lines.push(
Expand Down