Skip to content

docs: Hide private macros #156

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.

Sign up for GitHub

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

Merged
epage merged 1 commit into from
Nov 7, 2025
Merged

docs: Hide private macros #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions crates/libtest2/src/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#[macro_export]
#[doc(hidden)]
macro_rules! _main_parse {
(#[main] $(#[$meta:meta])* fn main $($item:tt)*) => {
static TESTS: $crate::_private::DistributedList<$crate::_private::DynCase> = $crate::_private::DistributedList::root();
Expand All @@ -14,6 +15,7 @@ macro_rules! _main_parse {
}

#[macro_export]
#[doc(hidden)]
#[allow(clippy::crate_in_macro_def)] // accessing item defined by `_main_parse`/`_parse_ignore`/`_run_test`, and recursively calling the macro itself
macro_rules! _test_parse {
// Entry point
Expand Down Expand Up @@ -133,6 +135,7 @@ macro_rules! _test_parse {
}

#[macro_export]
#[doc(hidden)]
macro_rules! _parse_ignore {
($context:expr, [$reason:literal] $(,)?) => {
$context.ignore_for($reason)?
Expand All @@ -144,6 +147,7 @@ macro_rules! _parse_ignore {
}

#[macro_export]
#[doc(hidden)]
macro_rules! _run_test {
($context:expr, [$expected:literal]) => {
$crate::panic::assert_panic_contains(|| run($context), $expected)
Expand Down