Skip to content

Conversation

@scholzp
Copy link

@scholzp scholzp commented Jun 29, 2023

Rust API guidelines state that methods of builders should return self to allow chaining.

Add missing documentation strings to builder functions.

The API guidelines state that methods of builders should return `self`
to allow chaining.

Add missing documentation strings to builder functions.
Copy link
Member

@phip1611 phip1611 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a changelog entry

You can create a new

## Unreleased
- foo

section in the changelog.

@scholzp
Copy link
Author

scholzp commented Jun 29, 2023

Please add a changelog entry

You can create a new

## Unreleased
- foo

section in the changelog.

I added the respective changelog entry. Because the changes made it necessary to modify the tests, I think this qualifies as a breaking change.

@phip1611
Copy link
Member

Please fix the integration test

Because the builder's methods now consume it, the integration test
failed. The MBI can now be produced directly by chaining them.
@phip1611 phip1611 merged commit ed11590 into rust-osdev:main Jun 29, 2023
@phip1611
Copy link
Member

Thanks for your contribution!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants