deno_doc icon indicating copy to clipboard operation
deno_doc copied to clipboard

jsdoc rendering summary can end with a `:`

Open crowlKats opened this issue 1 year ago • 2 comments

In some cases, a JSDoc summary can end with a :. We should change this by backtracking to a . if one is present and only show the content until then, else still show the summary as-is.

The relevant part of the codebase is https://github.com/denoland/deno_doc/blob/93f4ce335aba6e03cf52be4d5ed804068eee4937/src/html/jsdoc.rs#L392-L418

crowlKats avatar Sep 25 '24 11:09 crowlKats

I'd be interested in working on this but could you help provide an example of what the output is currently and what it should look like? Thanks!

c43721 avatar Nov 07 '24 23:11 c43721

@c43721 sure. for example: https://docs.deno.com/api/node/child_process/~/exec

The summary currently renders like this: Screenshot 2024-11-21 at 16 15 25 However since it ends with :, it should backtrack, so it should end up being this Screenshot 2024-11-21 at 16 15 50

crowlKats avatar Nov 21 '24 15:11 crowlKats