Shorten html::render by Nicholas-Baron · Pull Request #82088 · rust-lang/rust

Nicholas-Baron · 2021-02-14T07:22:38Z

The mod.rs for librustdoc's html::render was over 3,000 lines. This PR reduces it to around 2,300 by

Moving Context and associated impls to a separate file
Moving the print_item function and its helpers to a separate file
Moving write_shared and write_minify to their own file

Related to issue #60302.
Edit 1: SharedContext and related impls is only 72 lines and so will not be moved.

rust-highfive · 2021-02-14T07:22:41Z

r? @ollie27

(rust-highfive has picked a reviewer for you, use r? to override)

jyn514 · 2021-02-16T05:05:32Z

r? @GuillaumeGomez

jyn514 · 2021-02-21T02:27:54Z

@GuillaumeGomez this bitrots quickly, it would be nice to review it soon if possible.

Nicholas-Baron · 2021-02-21T21:51:19Z

The job mingw-check failed! Check out the build log: (web)(plain)
Click to see the possible cause of the failure (guessed by this bot)

The warning is regarding a is_dummy function in src/librustdoc/clean/types.rs. This file is not modified in this PR and I can find no place where it is used in the code touched by this PR and so I will not touch it, in the hope that some other PR fixes the issue.

bors · 2021-03-04T14:10:02Z

☔ The latest upstream changes (presumably #82756) made this pull request unmergeable. Please resolve the merge conflicts.

jyn514 · 2021-03-04T16:59:09Z

@bors delegate=Nicholas-Baron

This bitrots pretty quickly, so feel free to approve it yourself once you've fixed the conflict. Please use r=GuillaumeGomez and wait until CI passes on the PR first.

bors · 2021-03-04T16:59:11Z

✌️ @Nicholas-Baron can now approve this pull request

… used there

Due to a rebase, some edits were needed in the mod file.

Nicholas-Baron · 2021-03-04T18:59:53Z

@bors: r=GuillaumeGomez

bors · 2021-03-04T18:59:54Z

📌 Commit afb8220 has been approved by GuillaumeGomez

… r=GuillaumeGomez Shorten html::render The `mod.rs` for librustdoc's `html::render` was over 3,000 lines. This PR reduces it to around 2,300 by 1. Moving `Context` and associated `impl`s to a separate file 2. Moving the `print_item` function and its helpers to a separate file 3. Moving `write_shared` and `write_minify` to their own file Related to issue rust-lang#60302. Edit 1: `SharedContext` and related `impl`s is only 72 lines and so will not be moved.

…laumeGomez Rollup of 5 pull requests Successful merges: - rust-lang#76716 (Don't warn for `missing_doc_examples` when item is #[doc(hidden)]) - rust-lang#82088 (Shorten html::render) - rust-lang#82690 (Update rustdoc documentation) - rust-lang#82752 (Add a regression test for issue-81712) - rust-lang#82765 (Fix polymorphization ICE on associated types in trait decls using const generics in bounds) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

… r=GuillaumeGomez Shorten html::render The `mod.rs` for librustdoc's `html::render` was over 3,000 lines. This PR reduces it to around 2,300 by 1. Moving `Context` and associated `impl`s to a separate file 2. Moving the `print_item` function and its helpers to a separate file 3. Moving `write_shared` and `write_minify` to their own file Related to issue rust-lang#60302. Edit 1: `SharedContext` and related `impl`s is only 72 lines and so will not be moved.

rust-highfive assigned ollie27 Feb 14, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 14, 2021

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from 0862e34 to 206c443Compare February 14, 2021 22:52

rust-highfive assigned GuillaumeGomez and unassigned ollie27 Feb 16, 2021

jyn514 added C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 16, 2021

jyn514 reviewed Feb 16, 2021
View reviewed changes

Comment threadsrc/librustdoc/html/render/shared_context.rs Outdated
Comment threadsrc/librustdoc/html/render/context.rs Outdated

Nicholas-Baron force-pushed the shorten_html_render branch 2 times, most recently from 989fadb to 5273ca8Compare February 16, 2021 22:01

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from 5273ca8 to a899342Compare February 20, 2021 00:20

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from a899342 to c27b09aCompare February 20, 2021 00:32

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from c27b09a to aee0f7dCompare February 21, 2021 21:39

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from aee0f7d to 849c690Compare February 23, 2021 01:36

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from 849c690 to 5286284Compare February 27, 2021 03:01

This comment has been minimized.
Sign in to view

Nicholas-Baron force-pushed the shorten_html_render branch from 5286284 to 75ea154Compare February 27, 2021 06:07

This comment has been minimized.
Sign in to view

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Mar 4, 2021

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 4, 2021

Nicholas-Baron added 5 commits March 4, 2021 10:01

Moved Context and its impls to a separate file
48167c4

Moved print_item and helpers to a separate file
6c7d7a6

Moved the make_item_keywords function to context.rs as it is only…
14983b9
… used there

Moved write_shared to its own file
fd14e38

Corrected imports for render tests and mod files
afb8220
Due to a rebase, some edits were needed in the mod file.

Nicholas-Baron force-pushed the shorten_html_render branch from c34e695 to afb8220Compare March 4, 2021 18:25

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 4, 2021

GuillaumeGomez mentioned this pull request Mar 4, 2021
Rollup of 5 pull requests #82777
Merged

Dylan-DPC-zz mentioned this pull request Mar 5, 2021
Rollup of 9 pull requests #82785
Closed

JohnTitor mentioned this pull request Mar 5, 2021
Rollup of 10 pull requests #82790
Closed

m-ou-se mentioned this pull request Mar 5, 2021
Rollup of 15 pull requests #82794
Closed

bors merged commit 2f28361 into rust-lang:masterMar 5, 2021

rustbot added this to the 1.52.0 milestone Mar 5, 2021

Nicholas-Baron deleted the shorten_html_render branch March 5, 2021 23:21

Nicholas-Baron mentioned this pull request Mar 5, 2021
Split up files with // ignore-tidy-filelength#60302
Open
12 tasks

Uh oh!

Uh oh!

Conversation

Nicholas-Baron commented Feb 14, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Feb 14, 2021

Uh oh!

This comment has been minimized.

This comment has been minimized.

jyn514 commented Feb 16, 2021

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jyn514 commented Feb 21, 2021

Uh oh!

This comment has been minimized.

Nicholas-Baron commented Feb 21, 2021

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

bors commented Mar 4, 2021

Uh oh!

jyn514 commented Mar 4, 2021

Uh oh!

bors commented Mar 4, 2021

Uh oh!

Nicholas-Baron commented Mar 4, 2021

Uh oh!

bors commented Mar 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Nicholas-Baron commented Feb 14, 2021•
edited
Loading