print enum variant fields in docs

[oli-obk]

Right now we are repeating enum variants at the top, because the fields aren't shown with the actual docs. It's very annoying to have to scroll up and down to have both docs and field info. For struct variants we already list the fields.

enum docs look like this after this PR:

There are degenerate cases for enum tuple variants with lots of fields:

I was thinking that we could move the docs below the variant (slightly indented) or list the variant fields vertically instead of horizontally

r? @steveklabnik

[GuillaumeGomez]

I remember that someone talked about it (or maybe even open a PR?). Could you also provide a screenshot for your change please? I like to see wonderful changes rendered. 😃

[oli-obk]

These are the screenshots after my changes.

[GuillaumeGomez]

Oh, my bad. Could you align description text with the variant name please? (and screenshot with the change as well please 😛 )

[oli-obk]

updated PR for comments in irc: https://botbot.me/mozilla/rust-docs/2016-05-25/?msg=66694101&page=1

live version here: http://oli-obk.github.io/doc_publish/rustc/session/struct.Session.html

[GuillaumeGomez]

@oli-obk: For the overlap issue once collapsed:

.enum> .collapsed, .struct> .collapsed {
margin-bottom:25px;
}

[oli-obk]

updated (live version updated, too)

[oli-obk]

travis failure is an http-failure during apt-get

[oli-obk]

do you want me to remove the (now useless) enum/struct definition at the top?

[GuillaumeGomez]

If it's not used anymore, then yes please.

[GuillaumeGomez]

One last thing. You need to change:

.enum> .toggle-wrapper+ .docblock, .struct> .toggle-wrapper+ .docblock {
margin-left:10px;
margin-bottom:20px;
margin-top:5px;
}

to:

.enum> .toggle-wrapper+ .docblock, .struct> .toggle-wrapper+ .docblock {
margin-left:30px;
margin-bottom:20px;
margin-top:5px;
}

[oli-obk]

added changes and squashed commits

[GuillaumeGomez]

Ok, so this rule shouldn't be removed.

[GuillaumeGomez]

You need to move the css changes after this block:

span.since {
position: initial;
font-size:20px;
margin-right:5px;
}

[oli-obk]

updated and live version now looks good

[GuillaumeGomez]

Travis doesn't seem to be able to run apt-get. Strange... I'll put it in rollup and we'll see.

Thanks @oli-obk!

@bors r+ rollup

[bors]

📌 Commit 94c3679 has been approved by GuillaumeGomez

[bors]

⌛ Testing commit 94c3679 with merge 56ae85b...

[bors]

💔 Test failed - auto-linux-64-opt-rustbuild

[GuillaumeGomez]

A lot of doc tests are broken.

@bors: rollup-

[oli-obk]

I don't grok those error messages. How do I go about debugging them?

failures:
---- [rustdoc] rustdoc/impl-parts.rs stdout ----
error: htmldocck failed!
status: exit code: 1
command: "/usr/bin/python2.7" "/home/ws/ca8159/Projects/rust/rust/src/etc/htmldocck.py" "x86_64-unknown-linux-gnu/test/rustdoc/impl-parts.stage1-x86_64-unknown-linux-gnu" "/home/ws/ca8159/Projects/rust/rust/src/test/rustdoc/impl-parts.rs"
stdout:
------------------------------------------
------------------------------------------
stderr:
------------------------------------------
19: @has check failed
`XPATH PATTERN` did not match
// @has impl_parts/struct.Foo.html '//*[@class="impl"]//code' "impl<T: Clone> !AnOibit for Foo<T> where T: Sync"
21: @has check failed
`XPATH PATTERN` did not match
// @has impl_parts/trait.AnOibit.html '//*[@class="item-list"]//code' "impl<T: Clone> !AnOibit for Foo<T> where T: Sync"
Encountered 2 errors
------------------------------------------
thread '[rustdoc] rustdoc/impl-parts.rs' panicked at 'explicit panic', /home/ws/ca8159/Projects/rust/rust/src/tools/compiletest/src/runtest.rs:2231
note: Run with `RUST_BACKTRACE=1` for a backtrace.
---- [rustdoc] rustdoc/issue-20727-2.rs stdout ----
error: htmldocck failed!
status: exit code: 1
command: "/usr/bin/python2.7" "/home/ws/ca8159/Projects/rust/rust/src/etc/htmldocck.py" "x86_64-unknown-linux-gnu/test/rustdoc/issue-20727-2.stage1-x86_64-unknown-linux-gnu" "/home/ws/ca8159/Projects/rust/rust/src/test/rustdoc/issue-20727-2.rs"
stdout:
------------------------------------------
------------------------------------------
stderr:
------------------------------------------
18: @has check failed
`XPATH PATTERN` did not match
// @has - '//*[@class="rust trait"]' 'trait Add<RHS = Self> {'
28: @has check failed
`XPATH PATTERN` did not match
// @has - '//*[@class="rust trait"]' 'trait Add<RHS = Self> {'
Encountered 2 errors
------------------------------------------
thread '[rustdoc] rustdoc/issue-20727-2.rs' panicked at 'explicit panic', /home/ws/ca8159/Projects/rust/rust/src/tools/compiletest/src/runtest.rs:2231
---- [rustdoc] rustdoc/issue-20727-4.rs stdout ----
error: htmldocck failed!
status: exit code: 1
command: "/usr/bin/python2.7" "/home/ws/ca8159/Projects/rust/rust/src/etc/htmldocck.py" "x86_64-unknown-linux-gnu/test/rustdoc/issue-20727-4.stage1-x86_64-unknown-linux-gnu" "/home/ws/ca8159/Projects/rust/rust/src/test/rustdoc/issue-20727-4.rs"
stdout:
------------------------------------------
------------------------------------------
stderr:
------------------------------------------
18: @has check failed
`XPATH PATTERN` did not match
// @has - '//*[@class="rust trait"]' 'trait Index<Idx: ?Sized> {'
29: @has check failed
`XPATH PATTERN` did not match
// @has - '//*[@class="rust trait"]' 'trait IndexMut<Idx: ?Sized>: Index<Idx> {'
Encountered 2 errors
------------------------------------------
thread '[rustdoc] rustdoc/issue-20727-4.rs' panicked at 'explicit panic', /home/ws/ca8159/Projects/rust/rust/src/tools/compiletest/src/runtest.rs:2231
failures:
[rustdoc] rustdoc/impl-parts.rs
[rustdoc] rustdoc/issue-20727-2.rs
[rustdoc] rustdoc/issue-20727-4.rs
test result: FAILED. 99 passed; 3 failed; 1 ignored; 0 measured

[GuillaumeGomez]

It means the generated docs don't correspond to what tests expected. A small explanation of how it works is provided in "/home/ws/ca8159/Projects/rust/rust/src/etc/htmldocck.py".

[oli-obk]

Found the culprit. The python script treated   as something other than whitespace during matching.

[GuillaumeGomez]

Great, let's see what travis says and it'll be good to get merged.

[oli-obk]

travis likes it

[GuillaumeGomez]

Then here we go!

@bors: r+ rollup

[bors]

📌 Commit 39a5f3c has been approved by GuillaumeGomez

[GuillaumeGomez]

@bors: r-

Sorry, forgot to ask: can you squash your commits please?

[oli-obk]

done

[GuillaumeGomez]

Ok, now it's all good. Sorry about that.

@bors: r+ rollup

[bors]

📌 Commit b0c7033 has been approved by GuillaumeGomez