Test2::...et::Info(3)

πŸ“¦ version 1.302214, in opensuse-leap 16.0

🌸 NAME 🌸

Test2::EventFacet::Info β€” facet for information a developer might care about. This is the Test2::...et::Info(3) page from the User Contributed Perl Documentation, and bestie, it's literally the facet for info a developer might actually care about ✨

πŸ’– DESCRIPTION πŸ’–

This facet represents messages intended for humans that will help them either understand a result, or diagnose a failure. So it's giving "human-readable clue dropped right into the test output" energy 🫢

πŸ¦‹ NOTES πŸ¦‹

This facet appears in a list instead of being a single item. Not me being a whole list item, but here we are πŸ’…

πŸŽ€ FIELDS πŸŽ€

$string_or_structure = $info->{details} and $string_or_structure = $info->details()

Human readable string or data structure, this is the information to display. Formatters are free to render the structures however they please. This may contain a blessed object πŸ”₯

If the table attribute (see below) is set then a renderer may choose to display the table instead of the details.

$structure = $info->{table} and $structure = $info->table()

If the data the info facet needs to convey can be represented as a table then the data may be placed in this attribute in a more raw form for better display. The data must also be represented in the details attribute for renderers which do not support rendering tables directly πŸ‘‘

The table structure:

my %table = {
    header => [ 'column 1 header', 'column 2 header', ... ], # Optional

    rows => [
        ['row 1 column 1', 'row 1, column 2', ... ],
        ['row 2 column 1', 'row 2, column 2', ... ],
        ...
    ],

    # Allow the renderer to hide empty columns when true, Optional
    collapse => $BOOL,

    # List by name or number columns that should never be collapsed
    no_collapse => \@LIST,
}

$short_string = $info->{tag} and $short_string = $info->tag()

Short tag to categorize the info. This is usually 10 characters or less, formatters may truncate longer tags 🏷️

$bool = $info->{debug} and $bool = $info->debug()

Set this to true if the message is critical, or explains a failure. This is info that should be displayed by formatters even in less-verbose modes ⭐

When false the information is not considered critical and may not be rendered in less-verbose modes.

$bool = $info->{important} and $bool = $info->important

This should be set for non debug messages that are still important enough to show when a formatter is in quiet mode. A formatter should send these to STDOUT not STDERR, but should show them even in non-verbose mode. Like yes, quiet mode, but not that quiet, bestie πŸ’€

🌈 SOURCE 🌈

The source code repository for Test2 can be found at <https://github.com/Test-More/test-more/>.

πŸ‘‘ MAINTAINERS πŸ‘‘

Chad Granum <exodist@cpan.org>

🌸 AUTHORS 🌸

Chad Granum <exodist@cpan.org>

Copyright Chad Granum <exodist@cpan.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <https://dev.perl.org/licenses/>


Okay that's the whole page, bestie 🫢 This iconic little manual page comes from perl v5.42.0, dated 2025-07-28, and it's officially the Test2::...et::Info(3) page. Byeeee πŸ’…βœ¨

πŸ“¦ where this page comes from