Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

TRPL and Rustonomicon update to 1.8.0 #34

Closed
wants to merge 6 commits into from

Conversation

d3m3vilurr
Copy link

  • regex version up to 0.1.68
  • TRPL documents update
  • Add helper script about download TRPL documents

@killercup
Copy link
Owner

Cool! Did you render the html/pdf/epubs locally? I've had some problems with some tables IIRC.

@d3m3vilurr
Copy link
Author

Yep. results rendering looks good. can you share detail information about problem?

@killercup
Copy link
Owner

I don't remember it that well, I think it was something with unicode characters in a table? (The platform support table perhaps?) But it could be that the source material changed enough to make the rendering problems go away.

Could you upload the PDF version somewhere? I don't have time to get this set up here right now but I'd have a look at it and merge it if I don't find any regressions. (Actually, it would be really cool if you could send a PR to the gh-pages branch as well!)

Am 26.04.2016 um 14:37 schrieb Sunguk Lee notifications@github.com:

Yep. results rendering looks good. can you share detail information about problem?


You are receiving this because you commented.
Reply to this email directly or view it on GitHub

@d3m3vilurr
Copy link
Author

https://drive.google.com/folderview?id=0B4AMmzKpkyuKQlhrMFJON1hzbGs&usp=sharing uploaded output files. please check this :)
also i will make new pr to gh-pages few hour later.(currently i also hav'nt time)

@d3m3vilurr
Copy link
Author

Pushed new PR #35

@d3m3vilurr
Copy link
Author

wait a minute. i will fix nomicon path and will update nomicon document.

@d3m3vilurr
Copy link
Author

@killercup done. :)

@d3m3vilurr d3m3vilurr changed the title TRPL update to 1.8.0 TRPL and Rustonomicon update to 1.8.0 Apr 26, 2016
@killercup
Copy link
Owner

Thank you so much for doing this! I haven't had the time (and motivation, tbh) to do this recently, so it means a lot to me that you did this. I hope the Rust/pandoc/LaTeX setup was okay for you to get running, I know it's sometimes tricky.

I've just looked through the PDF versions and noticed a few things that need fixing before we can publish this. I'll just list them here:

  • The second chapter headline of the nomicon is actually just Gankro's big notice that the nomicon is a WIP. It's only a headline to make it bigger. You can reduce this to a simple paragraph in bold.
  • I remembered correctly! On page 14 of the A4 PDF of TRPL, there are no tick marks -- compare it to the book in HTML. A workaround for that might be to simply replace '✓' with a LaTeX glyph for that (here are some suggestions from stackoverflow). (The Japanese characters on page 148 are rendered beautifully by the way!)
  • The ASCII diagram on page 139 (TRPL A4 PDF) is still broken, but it's been broken since forever (see Replace Ascii Art in "Basic terminology: Crates and Modules" #11).
  • The table on page 188 (TRPL A4 PDF) is broken. Is the Markdown correct? I.e., does pandoc understand it?
  • There are code blocks page 225f, 275f, 278f, 281f, 293-298, and 304-307 (TRPL A4 PDF) that are not highlighted (probably just need to be rust or sh instead of ```). Feel free to make a PR for those changes on https://github.com/rust-lang/rust as well!
  • There are broken references on pages 233, 236, 239, 246, 253, 261, 265 (TRPL A4 PDF) which are rendered as "?? on page ??". At some of them seem to come from the fact that pandoc creates IDs for headlines in another way than rustdoc, so when the book contains references of not just pages but sections (link links to error-handling.html#composing-optiont-values) it may be that in our version those sections are actually called differently. I think I've had this problem before and just changed the links to whatever IDs pandoc creates.

Thanks again for your effort! It would be awesome if you could have a look at these 6 issues. Don't feel rushed, though. I haven't pushed an update for the book in half a year, so a few days don't make a difference :)

@d3m3vilurr
Copy link
Author

ok. i wll try to work that this weekend :)
but, i think, those issues need make new issue. this pr just update documents, so really need these issues to handle in this pr?

@killercup
Copy link
Owner

ok. i wll try to work that this weekend :)

Cool. As I said, no need to hurry.

but, i think, those issues need make new issue. this pr just update documents, so really need these issues to handle in this pr?

I don't want to merge a PR that makes things worse, i.e. introduces new issues, if there is no reason to.

@d3m3vilurr
Copy link
Author

ok i see :)

@royalstream
Copy link
Contributor

I also want the PDF so I was going to help with the code highlighting, doing a PR to the main repo.
However, it looks like they intentionally labeled them as no_run or ignore as opposed to rust.
I wonder what their intention was.

@killercup
Copy link
Owner

@royalstream You can label code snippets with multiple flags, e.g. rust,ignore. You just need to make sure it starts with rust.

@d3m3vilurr d3m3vilurr closed this May 18, 2016
@d3m3vilurr d3m3vilurr reopened this May 18, 2016
@royalstream
Copy link
Contributor

royalstream commented May 18, 2016

unless they explicitly don't want it to start with rust. I'm going to look at their testing to see what pattern they use to discriminate.

@killercup
Copy link
Owner

Rustdoc has no problem with rust,ignore and the like, it's just that rust
is assumed by default so people don't add it. I talked to Steve about
always annotating snippets with rust and he was okay with it.

Steven notifications@github.com schrieb am Mi., 18. Mai 2016 um 18:38:

unless they explicitly don't want it to start with rust. I'm going to look
at their testing to see how they test the snippets in the book and what
pattern they use to run or ignore them.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#34 (comment)

@royalstream
Copy link
Contributor

Alright, here it is. rust-lang/rust#33721

@killercup
Copy link
Owner

I just merged the other PR with newer source files, so I'll close this one.

@killercup killercup closed this Jun 2, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants