Set --extend-css stable #41700

GuillaumeGomez · 2017-05-02T10:28:07Z

I think it's now time to set this option stable.

r? @rust-lang/docs

alexcrichton · 2017-05-02T18:16:38Z

steveklabnik · 2017-05-03T09:56:51Z

Let's talk about this at a doc meeting.

steveklabnik · 2017-05-11T14:52:43Z

We decided at the docs meeting that since rustdoc is currently in-progress moving under devtools, we're gonna hold off until then.

GuillaumeGomez · 2017-05-11T16:13:50Z

😿

Mark-Simulacrum · 2017-05-11T21:00:42Z

@steveklabnik Could you elaborate about what "moving under devtools" means? I don't think I've heard of this yet, though I may have missed something...

GuillaumeGomez · 2017-05-12T09:06:07Z

A new team should be created (soon or not, not sure about this), and in this team, a subteam will officially handle rustdoc changes.

steveklabnik · 2017-05-15T13:39:48Z

@Mark-Simulacrum there's some restructuring of some parts of the teams going on, similar to how the new infrastructure team was spun up. Rustdoc's governance is part of this.

carols10cents · 2017-05-22T17:14:03Z

@rust-lang/dev-tools exists now! ping all of yinz!

Manishearth · 2017-05-22T18:32:47Z

ono i have 'sponsibilities now

(I'm a tool peer so I don't think I have to sign off on this, but, in case, 👍 from me)

killercup · 2017-05-22T18:43:05Z

With great power comes great opportunity to bikeshed! Okay, let me warm up with:

I'd prefer to have CSS written in uppercase in the description. Also, I'm not sure if this actually merits the e shortcut, i.e., if this option is used often enough for that. Usually, -e is for excluding things, not extending.

I'm 👍 on the general idea to stabilize the --extend-css, though.

nrc · 2017-05-22T21:14:34Z

We discussed this at the dev-tools meeting today. We were in favour of stabilising. There is a concern that since we do not want to freeze the HTML output by rustdoc, then user css could have different effects from version to version and this might make it more difficult to change rustdoc. However, there is basically no solution to this other than not stabilising the option. So, we think we should accept this PR (r+) on the condition that an extra line of documentation is added to the --help text making clear that there is not stability guarantee about the effect of any given CSS, only that the CSS will be applied.

GuillaumeGomez · 2017-05-23T07:57:14Z

Ok, will add it as well.

GuillaumeGomez · 2017-05-23T18:49:07Z

Updated. Is the help message good enough?

killercup · 2017-05-23T19:34:18Z

src/librustdoc/lib.rs

@@ -162,8 +162,9 @@ pub fn opts() -> Vec<RustcOptGroup> {
                      "URL to send code snippets to", "URL")),
        stable(optflag("", "markdown-no-toc", "don't include table of contents")),
        stable(optopt("e", "extend-css",
-                      "to redefine some css rules with a given file to generate doc with your \
-                       own theme", "PATH")),
+                      "To redefine some css rules with a given file to generate doc with your \


s/redefine/add
s/css/CSS
s/doc/the documentation

I'm not sure about the "add", but I think "redefine" sends the wrong message. You are not changing existing CSS rules, just adding more rules, that may be more specific (because of specificity) and thus appear like they replaced the default rules.

In addition to that it is also totally possible to add new rules for that .fancy-table you used in your docs.

(Sorry to continue do nitpick on this)

No problem, it avoids further fixes.

killercup · 2017-05-24T09:26:08Z

Thanks. The description looks good!

(Maybe drop the "to" at the beginning but that really doesn't matter 😅)

GuillaumeGomez · 2017-05-24T14:44:05Z

@bors: r=killercup

bors · 2017-05-24T14:44:06Z

📌 Commit b4d594f has been approved by killercup

bors · 2017-05-24T15:30:37Z

⌛ Testing commit b4d594f with merge bb8b661...

steveklabnik · 2017-05-24T15:31:58Z

(For posterity, @QuietMisdreavus and I both signed off on this as well)

bors · 2017-05-24T18:31:11Z

💔 Test failed - status-appveyor

Mark-Simulacrum · 2017-05-24T18:38:25Z

@bors retry

appveyor timeout

…=killercup Set --extend-css stable I think it's now time to set this option stable. r? @rust-lang/docs

Rollup of 16 pull requests - Successful merges: #41700, #41980, #42052, #42071, #42120, #42134, #42141, #42142, #42149, #42150, #42159, #42177, #42186, #42191, #42195, #42198 - Failed merges:

…=killercup Set --extend-css stable I think it's now time to set this option stable. r? @rust-lang/docs

bors · 2017-05-25T00:16:15Z

⌛ Testing commit b4d594f with merge 7f3ed6c...

Mark-Simulacrum · 2017-05-25T01:51:32Z

There's very little chance of this succeeding on its own due to appveyor slowness.

@bors retry

bors · 2017-05-25T04:38:59Z

⌛ Testing commit b4d594f with merge ffb0e2d...

Set --extend-css stable I think it's now time to set this option stable. r? @rust-lang/docs

bors · 2017-05-25T07:04:00Z

☀️ Test successful - status-appveyor, status-travis
Approved by: killercup
Pushing ffb0e2d to master...

Set --extend-css stable

7d4a6c8

arielb1 added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 2, 2017

alexcrichton assigned steveklabnik May 2, 2017

steveklabnik added I-nominated A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels May 3, 2017

carols10cents added S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 8, 2017

carols10cents added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels May 22, 2017

nrc added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed I-nominated S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). labels May 22, 2017

killercup reviewed May 23, 2017

View reviewed changes

killercup mentioned this pull request May 23, 2017

Update rustdoc man page #42180

Merged

Add precisions for the help message for --extend-css

b4d594f

GuillaumeGomez force-pushed the extend-css-stable branch from df30708 to b4d594f Compare May 23, 2017 22:15

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 24, 2017

Rollup merge of rust-lang#41700 - GuillaumeGomez:extend-css-stable, r…

9dd25c4

…=killercup Set --extend-css stable I think it's now time to set this option stable. r? @rust-lang/docs

Mark-Simulacrum mentioned this pull request May 24, 2017

Rollup of 16 pull requests #42203

Closed

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 25, 2017

Rollup merge of rust-lang#41700 - GuillaumeGomez:extend-css-stable, r…

006eca4

…=killercup Set --extend-css stable I think it's now time to set this option stable. r? @rust-lang/docs

Mark-Simulacrum mentioned this pull request May 25, 2017

Rollup of 16 pull requests #42209

Closed

bors added a commit that referenced this pull request May 25, 2017

Auto merge of #41700 - GuillaumeGomez:extend-css-stable, r=killercup

ffb0e2d

Set --extend-css stable I think it's now time to set this option stable. r? @rust-lang/docs

bors merged commit b4d594f into rust-lang:master May 25, 2017

GuillaumeGomez deleted the extend-css-stable branch May 25, 2017 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set --extend-css stable #41700

Set --extend-css stable #41700

GuillaumeGomez commented May 2, 2017

alexcrichton commented May 2, 2017

steveklabnik commented May 3, 2017

steveklabnik commented May 11, 2017

GuillaumeGomez commented May 11, 2017

Mark-Simulacrum commented May 11, 2017

GuillaumeGomez commented May 12, 2017

steveklabnik commented May 15, 2017

carols10cents commented May 22, 2017

Manishearth commented May 22, 2017 •

edited

killercup commented May 22, 2017

nrc commented May 22, 2017

GuillaumeGomez commented May 23, 2017

GuillaumeGomez commented May 23, 2017

killercup May 23, 2017 •

edited

GuillaumeGomez May 23, 2017

killercup commented May 24, 2017

GuillaumeGomez commented May 24, 2017

bors commented May 24, 2017

bors commented May 24, 2017

steveklabnik commented May 24, 2017

bors commented May 24, 2017

Mark-Simulacrum commented May 24, 2017

bors commented May 25, 2017

Mark-Simulacrum commented May 25, 2017

bors commented May 25, 2017

bors commented May 25, 2017

Set --extend-css stable #41700

Set --extend-css stable #41700

Conversation

GuillaumeGomez commented May 2, 2017

alexcrichton commented May 2, 2017

steveklabnik commented May 3, 2017

steveklabnik commented May 11, 2017

GuillaumeGomez commented May 11, 2017

Mark-Simulacrum commented May 11, 2017

GuillaumeGomez commented May 12, 2017

steveklabnik commented May 15, 2017

carols10cents commented May 22, 2017

Manishearth commented May 22, 2017 • edited

killercup commented May 22, 2017

nrc commented May 22, 2017

GuillaumeGomez commented May 23, 2017

GuillaumeGomez commented May 23, 2017

killercup May 23, 2017 • edited

Choose a reason for hiding this comment

GuillaumeGomez May 23, 2017

Choose a reason for hiding this comment

killercup commented May 24, 2017

GuillaumeGomez commented May 24, 2017

bors commented May 24, 2017

bors commented May 24, 2017

steveklabnik commented May 24, 2017

bors commented May 24, 2017

Mark-Simulacrum commented May 24, 2017

bors commented May 25, 2017

Mark-Simulacrum commented May 25, 2017

bors commented May 25, 2017

bors commented May 25, 2017

Manishearth commented May 22, 2017 •

edited

killercup May 23, 2017 •

edited