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.

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

Documentation with new lines will result in strange formatting #821

Closed
c43721 opened this issue Nov 7, 2024 · 3 comments
Closed

Documentation with new lines will result in strange formatting #821

c43721 opened this issue Nov 7, 2024 · 3 comments

Comments

@c43721
Copy link

c43721 commented Nov 7, 2024

Take the @std/fmt module as an example:

image

When scrolling through the docs, there's sometimes whitespace that's missing. However, if you go to the symbol docs the whitespace looks great:

image

Notice the tostdout has no space between to and stdout in the first example but does on the second example. This is how it looks in github

image

And in Visual Studio Code:
image

It seems like the problem is the new line, so I think this is a parsing issue.

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Nov 7, 2024
@c43721 c43721 changed the title Docs sometimes has missing spaces Documentation with new lines will result in strange formatting Nov 7, 2024
@c43721
Copy link
Author

c43721 commented Nov 7, 2024

I question if the proper solution is to adjust the documentation of the std library (in these examples) to keep the setence on one line or if the docs parser needs to be adjusted.

@crowlKats
Copy link
Collaborator

Duplicate of #737

@crowlKats crowlKats marked this as a duplicate of #737 Nov 7, 2024
@crowlKats crowlKats closed this as not planned Won't fix, can't repro, duplicate, stale Nov 7, 2024
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in JSR Nov 7, 2024
@c43721
Copy link
Author

c43721 commented Nov 7, 2024

Thanks, I'll add some context to that issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants