print enum variant fields in docs #33867

oli-obk · 2016-05-25T12:05:22Z

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 · 2016-05-25T13:31:27Z

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 · 2016-05-25T13:45:44Z

These are the screenshots after my changes.

GuillaumeGomez · 2016-05-25T14:19:01Z

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

oli-obk · 2016-05-25T16:35:39Z

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 · 2016-05-25T19:01:05Z

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

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

oli-obk · 2016-05-27T08:38:48Z

updated (live version updated, too)

oli-obk · 2016-05-27T08:58:40Z

travis failure is an http-failure during apt-get

oli-obk · 2016-05-27T09:07:51Z

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

GuillaumeGomez · 2016-05-27T09:38:32Z

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

GuillaumeGomez · 2016-05-27T09:41:48Z

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 · 2016-05-27T09:52:57Z

added changes and squashed commits

GuillaumeGomez · 2016-05-27T09:59:05Z

src/librustdoc/html/static/rustdoc.css

@@ -591,13 +610,11 @@ a.test-arrow {
 .collapse-toggle {
    font-weight: 300;
    position: absolute;
-    left: -23px;


Ok, so this rule shouldn't be removed.

GuillaumeGomez · 2016-05-27T10:01:17Z

You need to move the css changes after this block:

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

oli-obk · 2016-05-27T10:29:02Z

updated and live version now looks good

GuillaumeGomez · 2016-05-27T10:39:31Z

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 · 2016-05-27T10:41:21Z

📌 Commit 94c3679 has been approved by GuillaumeGomez

bors · 2016-05-29T06:45:18Z

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

bors · 2016-05-29T06:47:20Z

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

GuillaumeGomez · 2016-05-29T14:16:26Z

A lot of doc tests are broken.

@bors: rollup-

oli-obk · 2016-05-30T09:35:23Z

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 · 2016-05-30T09:58:54Z

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 · 2016-05-30T10:34:11Z

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

GuillaumeGomez · 2016-05-30T11:21:40Z

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

oli-obk · 2016-05-30T13:36:09Z

travis likes it

GuillaumeGomez · 2016-05-30T13:41:12Z

Then here we go!

@bors: r+ rollup

bors · 2016-05-30T13:41:13Z

📌 Commit 39a5f3c has been approved by GuillaumeGomez

GuillaumeGomez · 2016-05-30T13:41:58Z

@bors: r-

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

oli-obk · 2016-05-30T14:12:12Z

done

GuillaumeGomez · 2016-05-30T14:13:16Z

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

@bors: r+ rollup

bors · 2016-05-30T14:13:17Z

📌 Commit b0c7033 has been approved by GuillaumeGomez

@steveklabnik

…illaumeGomez print enum variant fields in docs 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: ![screenshot from 2016-05-25 14-02-42](https://cloud.githubusercontent.com/assets/332036/15539231/84b018cc-2281-11e6-9666-1063655931f4.png) There are degenerate cases for enum tuple variants with lots of fields: ![screenshot from 2016-05-25 14-01-00](https://cloud.githubusercontent.com/assets/332036/15539260/91e537ca-2281-11e6-8bf1-a3d6b2e78f65.png) 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

Rollup of 5 pull requests - Successful merges: #33867, #33926, #33942, #33958, #33964 - Failed merges:

rust-highfive assigned steveklabnik May 25, 2016

oli-obk force-pushed the rustdoc_variant_types branch from 00cd95e to 0dc0d1f Compare May 27, 2016 09:52

GuillaumeGomez reviewed May 27, 2016
View reviewed changes

oli-obk force-pushed the rustdoc_variant_types branch from 0dc0d1f to 94c3679 Compare May 27, 2016 10:28

print enum variant fields in docs

b0c7033

oli-obk force-pushed the rustdoc_variant_types branch from 39a5f3c to b0c7033 Compare May 30, 2016 14:12

Manishearth mentioned this pull request May 30, 2016

Rollup of 5 pull requests #33965

Merged

bors added a commit that referenced this pull request May 30, 2016

Auto merge of #33965 - Manishearth:rollup, r=Manishearth

f3bfa31

Rollup of 5 pull requests - Successful merges: #33867, #33926, #33942, #33958, #33964 - Failed merges:

bors merged commit b0c7033 into rust-lang:master May 30, 2016

oli-obk deleted the rustdoc_variant_types branch June 2, 2016 11:10

sanxiyn mentioned this pull request Jun 13, 2016

Fix invalid inlining #34234

Merged

birkenfeld mentioned this pull request Aug 7, 2016

rustdoc: Named fields should have their types displayed next to their descriptions #32024

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

print enum variant fields in docs #33867

print enum variant fields in docs #33867

oli-obk commented May 25, 2016 •

edited

Loading

GuillaumeGomez commented May 25, 2016 •

edited

Loading

oli-obk commented May 25, 2016

GuillaumeGomez commented May 25, 2016 •

edited

Loading

oli-obk commented May 25, 2016

GuillaumeGomez commented May 25, 2016

oli-obk commented May 27, 2016

oli-obk commented May 27, 2016 •

edited

Loading

oli-obk commented May 27, 2016

GuillaumeGomez commented May 27, 2016

GuillaumeGomez commented May 27, 2016 •

edited

Loading

oli-obk commented May 27, 2016

GuillaumeGomez May 27, 2016

GuillaumeGomez commented May 27, 2016

oli-obk commented May 27, 2016

GuillaumeGomez commented May 27, 2016 •

edited

Loading

bors commented May 27, 2016

bors commented May 29, 2016

bors commented May 29, 2016

GuillaumeGomez commented May 29, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

bors commented May 30, 2016

GuillaumeGomez commented May 30, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

bors commented May 30, 2016

print enum variant fields in docs #33867

print enum variant fields in docs #33867

Conversation

oli-obk commented May 25, 2016 • edited Loading

GuillaumeGomez commented May 25, 2016 • edited Loading

oli-obk commented May 25, 2016

GuillaumeGomez commented May 25, 2016 • edited Loading

oli-obk commented May 25, 2016

GuillaumeGomez commented May 25, 2016

oli-obk commented May 27, 2016

oli-obk commented May 27, 2016 • edited Loading

oli-obk commented May 27, 2016

GuillaumeGomez commented May 27, 2016

GuillaumeGomez commented May 27, 2016 • edited Loading

oli-obk commented May 27, 2016

GuillaumeGomez May 27, 2016

Choose a reason for hiding this comment

GuillaumeGomez commented May 27, 2016

oli-obk commented May 27, 2016

GuillaumeGomez commented May 27, 2016 • edited Loading

bors commented May 27, 2016

bors commented May 29, 2016

bors commented May 29, 2016

GuillaumeGomez commented May 29, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

bors commented May 30, 2016

GuillaumeGomez commented May 30, 2016

oli-obk commented May 30, 2016

GuillaumeGomez commented May 30, 2016

bors commented May 30, 2016

oli-obk commented May 25, 2016 •

edited

Loading

GuillaumeGomez commented May 25, 2016 •

edited

Loading

GuillaumeGomez commented May 25, 2016 •

edited

Loading

oli-obk commented May 27, 2016 •

edited

Loading

GuillaumeGomez commented May 27, 2016 •

edited

Loading

GuillaumeGomez commented May 27, 2016 •

edited

Loading