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

Use feature instead of exporting the crate for testing with hidden doc #476

Open
xieyuschen opened this issue Oct 16, 2024 · 0 comments · May be fixed by #478
Open

Use feature instead of exporting the crate for testing with hidden doc #476

xieyuschen opened this issue Oct 16, 2024 · 0 comments · May be fixed by #478

Comments

@xieyuschen
Copy link
Contributor

xieyuschen commented Oct 16, 2024

Currently, iceoryx exposes an API for testing purpose and hides its docs. I think a more reasonable approach is define a feature called iox2-test for it so we can ensure it won't be involved inside users code except the explicit feature setting up. A testing feature is needed because the default test doesn't support cross package usage.

/// Simple BumpAllocator for testing purposes. Do not use this in production. If you are looking
/// for a production ready BumpAllocator use the one from iceoryx2_bb_memory::bump_allocator
#[doc(hidden)]
pub struct BumpAllocator {

xieyuschen added a commit to xieyuschen/iceoryx2 that referenced this issue Oct 16, 2024
@xieyuschen xieyuschen linked a pull request Oct 16, 2024 that will close this issue
17 tasks
xieyuschen added a commit to xieyuschen/iceoryx2 that referenced this issue Oct 18, 2024
xieyuschen added a commit to xieyuschen/iceoryx2 that referenced this issue Oct 20, 2024
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 a pull request may close this issue.

1 participant