rustdoc: Rename `@has FILE PATTERN` to `@hasraw FILE PATTERN` #100355

camelid · 2022-08-10T04:55:47Z

rust-highfive · 2022-08-10T04:55:50Z

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

camelid · 2022-08-10T05:06:27Z

For future reference, I used variations of this Find&Replace regex:

@matches ([^ ]+) ("[^"]+")$

@matchestext $1 $2

camelid

There are several instances of multiline commands that were incorrectly that I'll need to fixup manually.

camelid · 2022-08-11T16:15:01Z

Oops forgot to update @!has.

bors · 2022-08-12T20:03:21Z

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

See rust-lang#100354 for the rationale.

Reasons: 1. It's shorter. 2. `@matches-literal` seems to contradict itself: a regex is intrinsically not a literal match, while it is still a textual match.

I think `@hasraw` is slightly clearer than `@hastext` since it is actually matching against the raw HTML, not the text nodes.

camelid

Left comments at each place where I noticed that @!has was being used incorrectly before. It used @!has (or the other commands) with an XPath that was actually treated as a literal string of HTML code. All or almost all of the uses were with the negated commands (e.g., `@!has) since otherwise the tests would've noticeably failed.

src/test/rustdoc/internal.rs

src/test/rustdoc/issue-61592.rs

src/test/rustdoc/no-crate-filter.rs

src/test/rustdoc/recursive-deref.rs

src/test/rustdoc/remove-url-from-headings.rs

src/test/rustdoc/table-in-docblock.rs

src/test/rustdoc/toggle-item-contents.rs

src/test/rustdoc/trait-impl-items-links-and-anchors.rs

src/test/rustdoc/trait-impl.rs

src/test/rustdoc/tuple-struct-fields-doc.rs

`@!has` (and `@!matches`) with two arguments used to treat the second argument as a literal string of HTML code. Now, that feature has been renamed into `@!hasraw` (and `@!matchesraw`), and the arity-2 `@!has` version is an error. These uses thought the second argument was being treated as an XPath, as with the arity-3 version, but in fact was being treated as literal HTML. Because these were checking for the *absence* of the string, the tests silently did nothing -- an XPath string won't ever be showing up in the test's generated HTML!

camelid · 2022-08-13T05:35:12Z

Ok, I fixed all the incorrect uses of @!has, and the tests passed. This is ready for review!

camelid · 2022-08-13T05:36:01Z

Maybe r? @GuillaumeGomez

(@Mark-Simulacrum feel free to review if you'd like, though not sure why highfive assigned you since this is rustdoc-related)

GuillaumeGomez · 2022-08-13T08:42:48Z

I'm confused: didn't you say in the issue that the problem was the commands should have a different name when then they had 2 vs 3 arguments? Because otherwise, I don't see the point of this PR: the command name is longer and definitely not more helpful.

camelid · 2022-08-13T14:11:10Z

That's what this PR does: it renames the 2-argument version to @hasraw. The 3-argument version is still @has. So this addresses the issue: they now have different names.

As you can see in the last commit, it turns out that a lot of tests made the same mistake I did and thought @has FILE PATTERN was the same as @has FILE PATTERN '' (which is what they intended).

Does that help? If not, please let me know which part you want me to clarify.

camelid · 2022-08-13T14:12:14Z

Note the 3-argument version keeps its name in this PR; only the 2-argument version is different.

GuillaumeGomez · 2022-08-13T16:21:30Z

Sorry, I completely missed it somehow. I'll make another review shortly then. Thanks for the extra explanation!

GuillaumeGomez · 2022-08-13T17:22:57Z

Thanks!

@bors r+

bors · 2022-08-13T17:22:58Z

📌 Commit 0d588e9 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…mpiler-errors Rollup of 11 pull requests Successful merges: - rust-lang#100355 (rustdoc: Rename ``@has` FILE PATTERN` to ``@hasraw` FILE PATTERN`) - rust-lang#100407 (avoid some int2ptr casts in thread_local_key tests) - rust-lang#100434 (Fix HIR pretty printing of let else) - rust-lang#100438 (Erase regions better in `promote_candidate`) - rust-lang#100445 (adapt test for msan message change) - rust-lang#100447 (Remove more Clean trait implementations) - rust-lang#100464 (Make `[rust] use-lld=true` work on windows) - rust-lang#100475 (Give a helpful diagnostic when the next struct field has an attribute) - rust-lang#100490 (wf: correctly `shallow_resolve` consts) - rust-lang#100501 (nicer Miri backtraces for from_exposed_addr) - rust-lang#100509 (merge two test directories that mean the same thing) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned Mark-Simulacrum Aug 10, 2022

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

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

camelid force-pushed the has2-rename branch from 9e27eee to 8490a50 Compare August 10, 2022 05:05

camelid force-pushed the has2-rename branch from 8490a50 to 111a5e9 Compare August 10, 2022 05:09

camelid commented Aug 10, 2022

View reviewed changes

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

This comment has been minimized.

Sign in to view

camelid force-pushed the has2-rename branch from 111a5e9 to b9e5db6 Compare August 10, 2022 20:21

camelid changed the title ~~rustdoc: Rename @has FILE PATTERN to @hastext FILE PATTERN~~ rustdoc: Rename @has FILE PATTERN to @hasraw FILE PATTERN Aug 10, 2022

This comment has been minimized.

Sign in to view

camelid added 5 commits August 13, 2022 00:35

Use different name for arity-2 @has and @matches

2787eb0

See rust-lang#100354 for the rationale.

Rename @{has,matches}-literal to ...text

01408fc

Reasons: 1. It's shorter. 2. `@matches-literal` seems to contradict itself: a regex is intrinsically not a literal match, while it is still a textual match.

Update tests: arity-2 @{has,matches} -> ...text

37eed1d

Rename @hastext to @hasraw (same for matches)

13d5327

I think `@hasraw` is slightly clearer than `@hastext` since it is actually matching against the raw HTML, not the text nodes.

Fix line lengths

9db6061

camelid force-pushed the has2-rename branch from d6b1fe7 to 992bf42 Compare August 13, 2022 04:39

camelid commented Aug 13, 2022

View reviewed changes

Update @!has name in tests

b34e240

camelid force-pushed the has2-rename branch from 992bf42 to b34e240 Compare August 13, 2022 04:52

camelid marked this pull request as ready for review August 13, 2022 05:33

camelid 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 Aug 13, 2022

rust-highfive assigned GuillaumeGomez and unassigned Mark-Simulacrum Aug 13, 2022

GuillaumeGomez approved these changes Aug 13, 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 Aug 13, 2022

compiler-errors mentioned this pull request Aug 13, 2022

Rollup of 11 pull requests #100511

Merged

bors merged commit 4b51df3 into rust-lang:master Aug 14, 2022

rustbot added this to the 1.65.0 milestone Aug 14, 2022

camelid deleted the has2-rename branch August 14, 2022 04:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: Rename `@has FILE PATTERN` to `@hasraw FILE PATTERN` #100355

rustdoc: Rename `@has FILE PATTERN` to `@hasraw FILE PATTERN` #100355

camelid commented Aug 10, 2022

rust-highfive commented Aug 10, 2022

camelid commented Aug 10, 2022 •

edited

Loading

camelid left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

camelid commented Aug 11, 2022

bors commented Aug 12, 2022

camelid left a comment

camelid commented Aug 13, 2022

camelid commented Aug 13, 2022

GuillaumeGomez commented Aug 13, 2022

camelid commented Aug 13, 2022

camelid commented Aug 13, 2022

GuillaumeGomez commented Aug 13, 2022

GuillaumeGomez commented Aug 13, 2022

bors commented Aug 13, 2022

rustdoc: Rename @has FILE PATTERN to @hasraw FILE PATTERN #100355

rustdoc: Rename @has FILE PATTERN to @hasraw FILE PATTERN #100355

Conversation

camelid commented Aug 10, 2022

rust-highfive commented Aug 10, 2022

camelid commented Aug 10, 2022 • edited Loading

camelid left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

camelid commented Aug 11, 2022

bors commented Aug 12, 2022

camelid left a comment

Choose a reason for hiding this comment

camelid commented Aug 13, 2022

camelid commented Aug 13, 2022

GuillaumeGomez commented Aug 13, 2022

camelid commented Aug 13, 2022

camelid commented Aug 13, 2022

GuillaumeGomez commented Aug 13, 2022

GuillaumeGomez commented Aug 13, 2022

bors commented Aug 13, 2022

rustdoc: Rename `@has FILE PATTERN` to `@hasraw FILE PATTERN` #100355

rustdoc: Rename `@has FILE PATTERN` to `@hasraw FILE PATTERN` #100355

camelid commented Aug 10, 2022 •

edited

Loading