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

Mark SPI slave as unstable #2853

Merged
merged 1 commit into from
Dec 20, 2024
Merged

Mark SPI slave as unstable #2853

merged 1 commit into from
Dec 20, 2024

Conversation

bugadani
Copy link
Contributor

No description provided.

@bugadani bugadani added the skip-changelog No changelog modification needed label Dec 20, 2024
@@ -216,7 +216,9 @@ macro_rules! unstable {
};
}

unstable! {
pub(crate) use unstable_module;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had to rename the macro, otherwise I couldn't re-export it.

@@ -91,16 +93,17 @@ const MAX_DMA_SIZE: usize = 32768 - 32;
/// SPI peripheral driver.
///
/// See the [module-level documentation][self] for more details.
#[instability::unstable]
Copy link
Contributor

Choose a reason for hiding this comment

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

given the whole module is unstable this is just to make the docs look nicer, right? (just in case I am missing something important here)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That, and we'll have to explicitly go through these once we commit to stabilizing SPI slave. FWIW rustdoc tends to ignore these, too, in places.

Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

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

LGTM

@JurajSadel JurajSadel added this pull request to the merge queue Dec 20, 2024
Merged via the queue into esp-rs:main with commit c2de8a1 Dec 20, 2024
28 checks passed
@bugadani bugadani deleted the spis branch December 20, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants