Skip to content
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

cleanup rustdoc::html::render to be better encapsulated. #138567

Open
lolbinarycat opened this issue Mar 16, 2025 · 4 comments · May be fixed by #138605
Open

cleanup rustdoc::html::render to be better encapsulated. #138567

lolbinarycat opened this issue Mar 16, 2025 · 4 comments · May be fixed by #138605
Assignees
@xizheyin
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@lolbinarycat
Copy link
Contributor

A lot of functions are marked as pub(crate), but are not actually called from outside the render module.

Additionally, the comment at the top of render/mod.rs should probably say that the main entrypoint is the impl of FormatRenderer on Context.
@lolbinarycat lolbinarycat 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 Mar 16, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Mar 16, 2025
@lolbinarycat lolbinarycat added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Mar 16, 2025
@xizheyin
Copy link
Contributor

Anyone? I can do this. @lolbinarycat

@xizheyin xizheyin linked a pull request Mar 17, 2025 that will close this issue
Open
@BigJoe17
Copy link

@lolbinarycat I can work on this issue

@xizheyin
Copy link
Contributor

Sorry, PR #138605 has been submitted yesterday. Maybe you can look at and modify other modules for items that aren't encapsulated well.
@BigJoe17

@BigJoe17
Copy link

alright I will check out other modules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xizheyin xizheyin

Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clean up librustdoc::html::render to be better encapsulated xizheyin/rust
4 participants
@lolbinarycat @rustbot @xizheyin @BigJoe17