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

Doc overview is missing white-spaces where line breaks are #737

Closed
bodograumann opened this issue Sep 23, 2024 · 1 comment · Fixed by #823
Closed

Doc overview is missing white-spaces where line breaks are #737

bodograumann opened this issue Sep 23, 2024 · 1 comment · Fixed by #823
Assignees
@crowlKats
Labels
bug Something isn't working docs gen Related to the documentation generation

Comments

@bodograumann
Copy link

In the generated docs there should be a white-space, were the source comment contains a line-break.
This is only broken in the overview page, but not in the details page of a symbol.

For example https://jsr.io/@std/random/doc says […]anoption may be customized by passing a[…], while https://jsr.io/@std/random/doc/~/Prng correctly says […]an option may be customized by passing a[…].
This seems to happen everewhere, but many doc comments don't contain multiple lines.
@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Sep 23, 2024
@crowlKats crowlKats added bug Something isn't working docs gen Related to the documentation generation labels Sep 25, 2024
@homersimpsons
Copy link

Another one from https://jsr.io/@std/testing/doc:

A BDD interfaceto Deno.test() API.

The sources contain a line break https://github.com/denoland/std/blob/ed79df4696e2e2522e08a18a5d4efb98b7de762d/testing/bdd.ts#L4-L5

@lucacasonato lucacasonato mentioned this issue Oct 28, 2024
Closed
@lucacasonato lucacasonato moved this from Needs Triage to Ready in JSR Oct 28, 2024
This was referenced Nov 5, 2024
Merged
Closed
@lucacasonato lucacasonato mentioned this issue Nov 8, 2024
Merged
@crowlKats crowlKats moved this from Ready to In Progress in JSR Nov 8, 2024
@crowlKats crowlKats self-assigned this Nov 8, 2024
github-merge-queue bot pushed a commit that referenced this issue Nov 13, 2024
@crowlKats
chore: update deno_doc and deno_ast (#823)
608cad5 
updates for denoland/deno_doc#656

Fixes #737
Fixes #794
@github-project-automation github-project-automation bot moved this from In Progress to Done in JSR Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@crowlKats crowlKats

Labels
bug Something isn't working docs gen Related to the documentation generation
Projects
JSR
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: update deno_doc and deno_ast jsr-io/jsr
3 participants
@bodograumann @crowlKats @homersimpsons