bevy-website icon indicating copy to clipboard operation
bevy-website copied to clipboard

Add utility to write Zola rustdoc `hide_lines`

Open doup opened this issue 3 years ago • 10 comments

This PR adds an utility app that automatically writes hide_lines Zola annotations on book contents.

Fixes #373

doup avatar Jul 26 '22 21:07 doup

I really like this, it will make writing code blocks way easier. The code looks fine to me, but I think you should add either a README or at least a top level doc comment that explains what it actually does. It took me a while to figure out exactly what it was doing and I'm already very familiar with the problem.

IceSentry avatar Jul 26 '22 21:07 IceSentry

In case you didn't see, most of the issues are fixed but I realized that it's modifying all lines endings, see: https://github.com/bevyengine/bevy-website/pull/405#discussion_r933167679

doup avatar Jul 30 '22 07:07 doup

bors try

alice-i-cecile avatar Aug 01 '22 15:08 alice-i-cecile

try

Build failed:

bors[bot] avatar Aug 01 '22 15:08 bors[bot]

@alice-i-cecile the build error was because the examples have changed and the generate_wasm_examples.sh is not in sync. This is fixed in master. I've applied the same fix (b2c11e8).

doup avatar Aug 02 '22 09:08 doup

bors r+

cart avatar Aug 30 '22 22:08 cart

Build failed:

bors[bot] avatar Aug 30 '22 22:08 bors[bot]

The failure looks unrelated to this PR. I'm not sure how to proceed though. :-/

doup avatar Sep 02 '22 12:09 doup

bors try

alice-i-cecile avatar Sep 02 '22 12:09 alice-i-cecile

try

Build failed:

bors[bot] avatar Sep 02 '22 12:09 bors[bot]

bors r+

cart avatar Oct 04 '22 19:10 cart

Build failed:

bors[bot] avatar Oct 04 '22 19:10 bors[bot]

Okay, looks like we need to update the book code to main!

alice-i-cecile avatar Oct 04 '22 19:10 alice-i-cecile

@alice-i-cecile do I need to do something from my part?

doup avatar Oct 05 '22 09:10 doup

Nope; there's no problem with this PR. However, someone (which could be you), needs to update the example code to use 0.9 syntax.

alice-i-cecile avatar Oct 05 '22 12:10 alice-i-cecile

Synced with latest changes in new-book.

doup avatar Jan 13 '23 22:01 doup

bors r+

alice-i-cecile avatar Jan 13 '23 22:01 alice-i-cecile

Pull request successfully merged into new-book.

Build succeeded:

bors[bot] avatar Jan 13 '23 22:01 bors[bot]