Skip to content

Rename Book.sections to Book.items #2813

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

Merged
merged 1 commit into from
Aug 23, 2025

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Aug 23, 2025

This renames the "sections" list to "items". In practice, this list has contained more than just "sections" since parts were added. Also, the rest of the code consistently uses the term "items", since the values it contains are called BookItems. Finally, the naming has always been a little confusing to me.

This is a very disruptive change, and I'm not doing it lightly. However, since there are a number of other API changes going into 0.5, I think now is an ok time to change this.

This renames the "sections" list to "items". In practice, this list has
contained more than just "sections" since parts were added. Also, the
rest of the code consistently uses the term "items", since the values it
contains are called `BookItem`s. Finally, the naming has always been a
little confusing to me.

This is a very disruptive change, and I'm not doing it lightly. However,
since there are a number of other API changes going into 0.5, I think
now is an ok time to change this.
@ehuss ehuss added the Breaking Change This would require a SemVer breaking change label Aug 23, 2025
@rustbot rustbot added the S-waiting-on-review Status: waiting on a review label Aug 23, 2025
@ehuss ehuss enabled auto-merge August 23, 2025 01:53
@ehuss ehuss added this pull request to the merge queue Aug 23, 2025
Merged via the queue into rust-lang:master with commit 313be71 Aug 23, 2025
14 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: waiting on a review label Aug 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change This would require a SemVer breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants