Remove extra space before a where clause #95813

Urgau · 2022-04-08T15:45:30Z

Remove extra space before where clause in the generated documentation.

The fix is to move the space before the break-line so that it doesn't appear visually but is still here. Removing it completely would create things like this impl<D> Delta<D>where D: MyTrait (missing a space before the where) which I don't think we want.

Added two regression test, first one test that the   is after the space and the second check that the   is before the spaces.

Before:

After:

r? @GuillaumeGomez

GuillaumeGomez · 2022-04-08T15:47:57Z

Thanks!

@bors: r+

bors · 2022-04-08T15:47:59Z

📌 Commit 1da3c4481904d5ce02a2bf437a7960962cc06428 has been approved by GuillaumeGomez

GuillaumeGomez · 2022-04-08T15:59:19Z

Ah, you forgot a fmt? 😄

@bors: r+

GuillaumeGomez · 2022-04-08T15:59:37Z

Oh actually, let's wait for the tests to pass to be sure.

@bors: r-

Urgau · 2022-04-08T16:02:25Z

Ah, you forgot a fmt? smile

Well I did a fmt but tidy checks everything including tests which fmt doesn't format at all.
My bad, sorry for the noise.

GuillaumeGomez · 2022-04-08T19:03:14Z

@bors: r+

bors · 2022-04-08T19:03:16Z

📌 Commit f6c7f10 has been approved by GuillaumeGomez

…=GuillaumeGomez Remove extra space before a where clause Remove extra space before where clause in the generated documentation. The fix is to move the space before the break-line so that it doesn't appear visually but is still here. Removing it completely would create things like this `impl<D> Delta<D>where D: MyTrait` (missing a space before the where) which I don't think we want. Added two regression test, first one test that the ` ` is after the space and the second check that the ` ` is before the spaces. Before: ![image](https://user-images.githubusercontent.com/3616612/162475212-d4bb6727-ed66-4a55-a4a2-4f55189bf8bd.png) After: ![image](https://user-images.githubusercontent.com/3616612/162475467-508fd082-60a7-4a8c-b693-8b188e8843e6.png) r? `@GuillaumeGomez`

…=GuillaumeGomez Remove extra space before a where clause Remove extra space before where clause in the generated documentation. The fix is to move the space before the break-line so that it doesn't appear visually but is still here. Removing it completely would create things like this `impl<D> Delta<D>where D: MyTrait` (missing a space before the where) which I don't think we want. Added two regression test, first one test that the ` ` is after the space and the second check that the ` ` is before the spaces. Before: ![image](https://user-images.githubusercontent.com/3616612/162475212-d4bb6727-ed66-4a55-a4a2-4f55189bf8bd.png) After: ![image](https://user-images.githubusercontent.com/3616612/162475467-508fd082-60a7-4a8c-b693-8b188e8843e6.png) r? ``@GuillaumeGomez``

Dylan-DPC · 2022-04-09T03:56:24Z

failed in rollup

Dylan-DPC · 2022-04-09T03:56:30Z

@bors r-

Urgau · 2022-04-11T10:41:08Z

I've opened #95933 to do comparison on the actual tree instead of the plain html.

@rustbot label -S-waiting-on-review +S-waiting-on-author +S-blocked

Urgau · 2022-04-11T11:31:05Z

@GuillaumeGomez Any idea about how to proceed to fix the CI issue (as #95933 was rejected) ?

@rustbot label -S-blocked

Urgau · 2022-04-11T12:31:10Z

After chatting in PM on Zulip with @GuillaumeGomez we found out that the problem probably lies in

rust/src/etc/htmldocck.py

Line 417 in d00e770

actual_str = ET.tostring(tree).decode('utf-8')

which doesn't preserve the order of the attributes leading to the attribute order changed.

We are currently investigating potential solutions.

…e, r=GuillaumeGomez htmldocck: Compare HTML tree instead of plain text html This PR improves `htmldocck` by comparing HTML trees instead of plain text html in the case of doing a ``@snapshot`` test. This fix the [CI issue](https://github.com/rust-lang-ci/rust/runs/5964305020?check_suite_focus=true) encounter in rust-lang#95813 where for some unknown reason one of the attributes is not always at the same place. The code is largely based on https://github.com/formencode/formencode/blob/3a1ba9de2fdd494dd945510a4568a3afeddb0b2e/formencode/doctest_xml_compare.py#L72-L120 which is behind MIT License. The comparison function is straightforward except for the `text_compare` function which does some weird stuff that we may want to simply reduce to a plain old comparison. r? `@GuillaumeGomez`

…e, r=GuillaumeGomez htmldocck: Compare HTML tree instead of plain text html This PR improves `htmldocck` by comparing HTML trees instead of plain text html in the case of doing a ```@snapshot``` test. This fix the [CI issue](https://github.com/rust-lang-ci/rust/runs/5964305020?check_suite_focus=true) encounter in rust-lang#95813 where for some unknown reason one of the attributes is not always at the same place. The code is largely based on https://github.com/formencode/formencode/blob/3a1ba9de2fdd494dd945510a4568a3afeddb0b2e/formencode/doctest_xml_compare.py#L72-L120 which is behind MIT License. The comparison function is straightforward except for the `text_compare` function which does some weird stuff that we may want to simply reduce to a plain old comparison. r? ``@GuillaumeGomez``

Urgau · 2022-04-17T09:58:04Z

#95933 was merged. This should be ready for another re-approval.

@rustbot ready

GuillaumeGomez · 2022-04-17T09:59:11Z

Please rebase it on master so we can ensure it's working as expected. :)

GuillaumeGomez · 2022-04-19T14:15:15Z

Thanks for fixing the HTML checker. :)

@bors: r+ rollup

bors · 2022-04-19T14:15:16Z

📌 Commit f7ce145 has been approved by GuillaumeGomez

…=GuillaumeGomez Remove extra space before a where clause Remove extra space before where clause in the generated documentation. The fix is to move the space before the break-line so that it doesn't appear visually but is still here. Removing it completely would create things like this `impl<D> Delta<D>where D: MyTrait` (missing a space before the where) which I don't think we want. Added two regression test, first one test that the ` ` is after the space and the second check that the ` ` is before the spaces. Before: ![image](https://user-images.githubusercontent.com/3616612/162475212-d4bb6727-ed66-4a55-a4a2-4f55189bf8bd.png) After: ![image](https://user-images.githubusercontent.com/3616612/162475467-508fd082-60a7-4a8c-b693-8b188e8843e6.png) r? `@GuillaumeGomez`

Rollup of 6 pull requests Successful merges: - rust-lang#95740 (asm: Add a kreg0 register class on x86 which includes k0) - rust-lang#95813 (Remove extra space before a where clause) - rust-lang#96029 (Refactor loop into iterator; simplify negation logic.) - rust-lang#96162 (interpret: Fix writing uninit to an allocation) - rust-lang#96165 (Miri provenance cleanup) - rust-lang#96205 (Use futex locks on emscripten.) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned GuillaumeGomez Apr 8, 2022

rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 8, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 8, 2022

GuillaumeGomez approved these changes Apr 8, 2022

View reviewed changes

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-review Status: Awaiting review from the assignee but also interested parties. labels Apr 8, 2022

Urgau force-pushed the rustdoc-where-clause-space branch from 1da3c44 to f6c7f10 Compare April 8, 2022 15:58

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 Apr 8, 2022

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 Apr 8, 2022

Dylan-DPC mentioned this pull request Apr 8, 2022

Rollup of 7 pull requests #95827

Closed

Urgau mentioned this pull request Apr 8, 2022

rustdoc: Clean up html::format::print_where_clause #95828

Merged

Dylan-DPC mentioned this pull request Apr 9, 2022

Rollup of 6 pull requests #95830

Closed

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 Apr 9, 2022

Urgau force-pushed the rustdoc-where-clause-space branch from f6c7f10 to 3b0f99e Compare April 9, 2022 08:07

Urgau mentioned this pull request Apr 11, 2022

htmldocck: Compare HTML tree instead of plain text html #95933

Merged

rustbot removed the S-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. label Apr 11, 2022

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 17, 2022

Remove extra space before a where clause in the documentation

f7ce145

Urgau force-pushed the rustdoc-where-clause-space branch from b127f82 to f7ce145 Compare April 17, 2022 10:34

GuillaumeGomez approved these changes Apr 19, 2022

View reviewed changes

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-review Status: Awaiting review from the assignee but also interested parties. labels Apr 19, 2022

GuillaumeGomez mentioned this pull request Apr 19, 2022

Greatly improve rustdoc xpath checks #89676

Closed

Dylan-DPC mentioned this pull request Apr 19, 2022

Rollup of 6 pull requests #96218

Closed

Dylan-DPC mentioned this pull request Apr 19, 2022

Rollup of 6 pull requests #96224

Merged

bors merged commit a0ba15b into rust-lang:master Apr 20, 2022

rustbot added this to the 1.62.0 milestone Apr 20, 2022

Urgau deleted the rustdoc-where-clause-space branch May 5, 2023 16:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove extra space before a where clause #95813

Remove extra space before a where clause #95813

Urgau commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

bors commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

Urgau commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

bors commented Apr 8, 2022

Dylan-DPC commented Apr 9, 2022

Dylan-DPC commented Apr 9, 2022

Urgau commented Apr 11, 2022

Urgau commented Apr 11, 2022 •

edited

Loading

Urgau commented Apr 11, 2022 •

edited

Loading

Urgau commented Apr 17, 2022

GuillaumeGomez commented Apr 17, 2022

GuillaumeGomez commented Apr 19, 2022

bors commented Apr 19, 2022

Remove extra space before a where clause #95813

Remove extra space before a where clause #95813

Conversation

Urgau commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

bors commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

Urgau commented Apr 8, 2022

GuillaumeGomez commented Apr 8, 2022

bors commented Apr 8, 2022

Dylan-DPC commented Apr 9, 2022

Dylan-DPC commented Apr 9, 2022

Urgau commented Apr 11, 2022

Urgau commented Apr 11, 2022 • edited Loading

Urgau commented Apr 11, 2022 • edited Loading

Urgau commented Apr 17, 2022

GuillaumeGomez commented Apr 17, 2022

GuillaumeGomez commented Apr 19, 2022

bors commented Apr 19, 2022

Urgau commented Apr 11, 2022 •

edited

Loading

Urgau commented Apr 11, 2022 •

edited

Loading