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

Missing spaces in Deno API docs #988

Closed
muzimuzhi opened this issue Oct 11, 2024 · 2 comments
Closed

Missing spaces in Deno API docs #988

muzimuzhi opened this issue Oct 11, 2024 · 2 comments

Comments

@muzimuzhi
Copy link
Contributor

muzimuzhi commented Oct 11, 2024 •
edited
Loading

https://docs.deno.com/api/deno/subprocess
image

It seems the positions where spaces were missing are all newlines in the JSDoc sources. I didn't find the doc source of the second case, deprecated Deno.process.

https://github.com/denoland/deno/blob/94b588ce6624ae2f2ed648c7b1a479a10513542f/cli/tsc/dts/lib.deno.ns.d.ts#L3715-L3720

  /**
   * The interface for handling a child process returned from
   * {@linkcode Deno.Command.spawn}.
   *
   * @category Subprocess
   */

https://github.com/denoland/deno/blob/94b588ce6624ae2f2ed648c7b1a479a10513542f/cli/tsc/dts/lib.deno.ns.d.ts#L4595-L4598

  /** Send a signal to process under given `pid`. The value and meaning of the
   * `signal` to the process is operating system and process dependant.
   * {@linkcode Signal} provides the most common signals. Default signal
   * is `"SIGTERM"`.
   * ...
   */
@muzimuzhi
Copy link
Contributor Author

The problem doesn't reproduce in the HTML doc generated from a simple main.ts, by running deno doc --html main.ts. Thus maybe it comes from codes in ./reference_gen.

/** Send a signal to process under given `pid`. The value and meaning of the
 * `signal` to the process is operating system and process dependant.
 * {@linkcode Signal} provides the most common signals. Default signal
 * is `"SIGTERM"`.
 */
export function add(a: number, b: number): number {
  return a + b;
}

if (import.meta.main) {
  console.log("Add 2 + 3 =", add(2, 3));
}

@crowlKats
Copy link
Member

closing as fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@muzimuzhi @crowlKats