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.

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

Deprecate the _previous_next_doc.html.erb partial in 7.x #2711

Merged
merged 2 commits into from
May 9, 2022

Conversation

barmintor
Copy link
Contributor

@barmintor barmintor commented May 7, 2022

Deprecate _previous_next_doc.html.erb partial, which does nothing but render a component.
Deprecate render_document_main_content_partial helper, which does nothing but render a partial.

Removed partial and helper in main/ 8.0; see also #2708 and #2709

@barmintor barmintor changed the title Remove the _previous_next_doc.html.erb partial Deprecate the _previous_next_doc.html.erb partial in 7.x May 7, 2022
Complaints have been made about how challenging it is to follow program execution through various partials, helpers and components.  I identified that the _previous_next_doc.html.erb partial does nothing but render a component. We can remove this partial and make it easier for people reading the code to follow the control flow.
All this method does is call a partial

To make the program flow easier to understand, we can just render the partial and avoid the helper call.
@barmintor barmintor merged commit 2b6397b into release-7.x May 9, 2022
@barmintor barmintor deleted the 7.x-deprecate_prev_next branch May 9, 2022 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants