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

Fix prop docs line breaks #1573

Merged
merged 3 commits into from
Oct 25, 2023

Conversation

tigerros
Copy link

@tigerros tigerros commented Oct 23, 2023

I'm sorry for creating a third PR for this, but I just noticed that there's one too many line breaks in the generated docs for props (see #1563 and #1565). I changed it to use the Rustdoc approach, which puts text separated by two lines into separate <p> elements. Previously, it just replaced \n with <br/>

Right now, this documentation:

/// Doc.
/// Next line.

Would generate:

Doc.
Next line.

But it's actually supposed to be:

Doc. Next line.

And when you used two new lines, the gap between them would be too big. Example image with the bug:
image
Fixed:
image
Regular Rustdoc:
image

@tigerros
Copy link
Author

tigerros commented Oct 23, 2023

I'm confused why the checks are failing. cargo check --all --examples --tests compiles on my machine. I didn't change any versions either which seems to be the problem...

@ealmloff
Copy link
Member

ealmloff commented Oct 23, 2023

I'm confused why the checks are failing. cargo check --all --examples --tests compiles on my machine. I didn't change any versions either which seems to be the problem...

Some dependency of dioxus may have updated within the last hour since the previous CI run. CI will always use the latest version of dependancies like you always run cargo update before you build

@tigerros
Copy link
Author

tigerros commented Oct 23, 2023

I ran cargo update and cargo check --all --examples --tests and still no error.

@jkelleyrtp
Copy link
Member

Looks great - thanks @tigerros !

@jkelleyrtp jkelleyrtp merged commit 035f26d into DioxusLabs:master Oct 25, 2023
10 checks passed
@jkelleyrtp jkelleyrtp added this to the 0.5.0: Signals milestone Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants