eclipse-iceoryx / eclipse-iceoryx/iceoryx2

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

Open
#476 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
2.5k
Forks
185
Avg merge
1d 23h
Merged PRs (30d)
47

Description

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.

https://github.com/eclipse-iceoryx/iceoryx2/blob/558c727395f50793f4e341dae73dd7315c4f6a4f/iceoryx2-bb/elementary/src/bump_allocator.rs#L17-L20

Contributor guide

Open the contributing guide

Research direction

Start with iceoryx2-bb/elementary/src/bump_allocator.rs at lines 17-20 and inspect how the testing API is currently exported and hidden from documentation. Trace the crate feature configuration and cross-package test setup; done means the API is available only when the explicit iox2-test feature is enabled and cross-package tests can use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.