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

examples/usercmodule: Include API headers in the C++ example. #14370

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

stinos
Copy link
Contributor

@stinos stinos commented Apr 24, 2024

Make the CI builds compile the public API as C++ to catch accidental introductions of incompatible code.

See #14323

Make the CI builds compile the public API as C++ to catch accidental
introductions of incompatible code.

Signed-off-by: stijn <stijn@ignitron.net>
@projectgus
Copy link
Contributor

Adding CI build coverage for C++ is good, but adding it as code in a user-facing example (that's primarily something someone can take, learn from, and adapt into their own code) seems not ideal. It's a lot of extra noise for someone who's just starting out with the C API.

MicroPython doesn't (to my knowledge) have a category of "build tests" (i.e. things that are functionally examples, but exist for project development and test purposes.) Maybe this could be the use case for the first one?

Copy link

codecov bot commented Apr 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.39%. Comparing base (9c7f065) to head (a65076a).
Report is 8 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #14370   +/-   ##
=======================================
  Coverage   98.39%   98.39%           
=======================================
  Files         161      161           
  Lines       21204    21204           
=======================================
  Hits        20864    20864           
  Misses        340      340           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stinos
Copy link
Contributor Author

stinos commented Apr 26, 2024

Fair point. Practically: create a tests/ subdirectory for this code then? Preference for a name?

i.e. things that are functionally examples, but exist for project development and test purposes

The tests/ directory has a bunch of things which fall under that category imo. The socket multi tests etc.

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.

None yet

2 participants