Skip to content

rustdoc: Encapsulate "clean generics before args" ordering requirement in a function #90778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
camelid opened this issue Nov 10, 2021 · 3 comments
Open

rustdoc: Encapsulate "clean generics before args" ordering requirement in a function #90778

camelid opened this issue Nov 10, 2021 · 3 comments
Assignees
@camelid
Labels
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.

Comments

@camelid
Copy link
Member

camelid commented Nov 10, 2021

I discovered in #90750 that several places in rustdoc panic if a function's generics are not cleaned before its arguments. It'd be good to extract a helper function to encapsulate that requirement so it's not spread across several places in the code.

cc @GuillaumeGomez @jyn514
@camelid camelid 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 Nov 10, 2021
@camelid
Copy link
Member Author

camelid commented Nov 10, 2021

(Not marking as E-easy since I'm not sure how easy this is.)

@GuillaumeGomez
Copy link
Member

(Not marking as E-easy since I'm not sure how easy this is.)

And I think you did well. 😆

@camelid
Copy link
Member Author

camelid commented Nov 10, 2021

Assigning myself for now since I may look into it.

@camelid camelid self-assigned this Nov 10, 2021
@camelid camelid mentioned this issue Nov 10, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@camelid camelid

Labels
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.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@GuillaumeGomez @camelid