Skip to content

Conversation

@bjoernQ
Copy link
Contributor

@bjoernQ bjoernQ commented Oct 15, 2025

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • I have added necessary changes to user code to the latest Migration Guide.
  • My changes are in accordance to the esp-rs developer guidelines

Extra:

Pull Request Details 📖

Description

This sparked from esp-rs/esp-generate#241 (comment)

Not sure if this needs a changelog entry

Testing

manual testing and inspecting the generated code

@bjoernQ bjoernQ added the skip-changelog No changelog modification needed label Oct 15, 2025
async fn __embassy_main(#fargs) #out {
#f_body
#(#lint_attrs)*
pub(crate) mod __main {
Copy link
Contributor

@bugadani bugadani Oct 15, 2025

Choose a reason for hiding this comment

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

This module means the main function no longer shows up in rustdoc, right? Why is it necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we'd need to PR a change in https://github.com/embassy-rs/embassy/blob/main/embassy-executor-macros/src/macros/task.rs for that to work

I have never seen the main function showing up in docs 🤔 it's all doc-hidden AFAICS - so this looked like an straight forward solution without obvious drawbacks

@bjoernQ bjoernQ added this pull request to the merge queue Oct 15, 2025
Merged via the queue into esp-rs:main with commit a5fd166 Oct 15, 2025
30 of 31 checks passed
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.

2 participants