rustdoc: Add `ItemTemplate` trait and related functions to avoid repetitively wrapping existing functions by nicklimmm · Pull Request #111946 · rust-lang/rust

nicklimmm · 2023-05-25T12:45:14Z

This trait will be used extensively in performing migrations to Askama templates (tracking issue: #108868)

rustbot · 2023-05-25T12:45:24Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @jsha (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

nicklimmm · 2023-05-25T12:47:48Z

r? @GuillaumeGomez

nicklimmm · 2023-05-25T17:50:48Z

FYI: "Return position impl Trait in traits" RFC is now entering its final comment period (comment)

Through this, we might be able to enhance the trait further.

GuillaumeGomez · 2023-05-26T14:20:03Z

src/librustdoc/html/templates/item_union.html

 {% endif %}
-{{ self.render_assoc_items() | safe }}
-{{ self.document_type_layout() | safe }}
+{{ self::item_template_render_assoc_items(self.borrow()) | safe }}


I just thought about something: could we instead of calling .borrow() change the API of item_template_render_assoc_items to take a &RefCell<T> where T: ItemTemplate or something equivalent to not have to write .borrow() every time? I'm not sure if it's possible though. If you could confirm it, it'd be awesome!

self::item_template_render_attributes_in_pre(self) | safe expands to

Without .borrow(): &::askama::filters::safe(::askama::Html, self::item_template_render_attributes_in_pre(&(self)))?

With .borrow(): &::askama::filters::safe(::askama::Html, self::item_template_render_attributes_in_pre({self.borrow()}))?

I'm not sure why the function didn't catch &(self) as &impl ItemTemplate, but self.borrow() does here (self.borrow() returns &ItemUnion) ...

I found out that we can remove .borrow() calls by:

Implementing ItemTemplate trait for &ItemUnion

The compiler suggested this after I removed .borrow()

We should use blanket impls to prevent writing the same impl blocks multiple times

Implementing askama::Template trait for &ItemUnion

Due to the derive macro doesn't implement askama::Template for &T

Can't apply blanket impls here since Template is from an external crate (not sure if we should make a feature request for this to be available)

Implication: we need to copy over the associated types and wrap methods from T

Possible to use macros here

I'm pretty much stuck at this point, what do you think? @GuillaumeGomez

I really like the first suggestion which also seems to be the simplest to be implemented (but maybe I'm wrong there). Thanks for taking a look! So what do you prefer: making the changes here directly or opening an issue and fixing it in a follow-up PR?

Oops, I laid them out wrongly, they should be implemented together.

Doing only the 1st item will cause errors, and the compiler suggested to do the 2nd item to fix it.

Oh I see. Well, that still seems doable. Then same question for how you prefer things to roll out. :)

I really like the first suggestion which also seems to be the simplest to be implemented (but maybe I'm wrong there). Thanks for taking a look! So what do you prefer: making the changes here directly or opening an issue and fixing it in a follow-up PR?

Nevertheless, I'd prefer to do a follow-up PR and open up a new issue. I would like to see opinions from others (in case there exists something simpler).

Let's go this way then! I r+ this PR. Please open an issue. ;)

GuillaumeGomez · 2023-05-26T14:20:26Z

Looks good to me, thanks! Just one thing I'm wondering about but after that we can merge.

GuillaumeGomez · 2023-05-27T12:03:01Z

Thanks for the work!

@bors r+ rollup

bors · 2023-05-27T12:03:03Z

📌 Commit fbdc511 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#108630 (Fix docs for `alloc::realloc`) - rust-lang#109084 (rustc driver: Remove argument 0 before at-expansion to prevent ICE) - rust-lang#111181 (fix(parse): return unpected when current token is EOF) - rust-lang#111656 (Use an unbounded lifetime in `String::leak`.) - rust-lang#111946 (rustdoc: Add `ItemTemplate` trait and related functions to avoid repetitively wrapping existing functions) - rust-lang#112018 (Clean up usage of `cx.tcx` when `tcx` is already set into a variable) r? `@ghost` `@rustbot` modify labels: rollup

…, r=GuillaumeGomez rustdoc: Add `item_template` macro Closes rust-lang#112021 This change removes the use of `self.borrows()` in Askama templates, removes code duplication from `item_and_mut_cx()`, and improved readability by eliminating the prefix `item_template_` when calling from the template. References: - Discussion issue: rust-lang#112021 - `ItemTemplate` PR: rust-lang#111946 r? `@GuillaumeGomez`

Add ItemTemplate trait

fbdc511

rustbot assigned jsha May 25, 2023

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels May 25, 2023

rustbot assigned GuillaumeGomez and unassigned jsha May 25, 2023

GuillaumeGomez reviewed May 26, 2023

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 May 27, 2023

nicklimmm mentioned this pull request May 27, 2023

rustdoc: remove .borrow() calls in Askama templates for ItemTemplate implementors #112021

Closed

2 tasks

matthiaskrgr mentioned this pull request May 27, 2023

Rollup of 6 pull requests #112025

Merged

bors merged commit 9a4fce9 into rust-lang:master May 27, 2023

rustbot added this to the 1.71.0 milestone May 27, 2023

nicklimmm mentioned this pull request Jun 2, 2023

rustdoc: Add item_template macro #112202

Merged

Uh oh!

Conversation

nicklimmm commented May 25, 2023

Uh oh!

rustbot commented May 25, 2023

Uh oh!

nicklimmm commented May 25, 2023

Uh oh!

nicklimmm commented May 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez May 26, 2023

Choose a reason for hiding this comment

Uh oh!

nicklimmm May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicklimmm May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicklimmm May 27, 2023

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez May 27, 2023

Choose a reason for hiding this comment

Uh oh!

nicklimmm May 27, 2023

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez May 27, 2023

Choose a reason for hiding this comment

Uh oh!

nicklimmm May 27, 2023

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez May 27, 2023

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented May 26, 2023

Uh oh!

GuillaumeGomez commented May 27, 2023

Uh oh!

bors commented May 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

nicklimmm commented May 25, 2023 •

edited

Loading

nicklimmm May 26, 2023 •

edited

Loading

nicklimmm May 26, 2023 •

edited

Loading