• NAME
• DESCRIPTION
• IMPLEMENTATION DETAILS
• Test2::API
• Test2::API::Instance
• SEE ALSO
• SOURCE
• MAINTAINERS
• AUTHORS
• COPYRIGHT

NAME

Test2::Manual::Anatomy::API - Internals documentation for the API.

DESCRIPTION

This document covers some of the internals of the Test2::API manpage.

IMPLEMENTATION DETAILS

Test2::API

the Test2::API manpage provides a functional interface to any test2 global state. This API should be preserved regardless of internal details of how and where the global state is stored.

This module itself does not store any state (with a few minor exceptions) but instead relies on the Test2::API::Instance manpage to store state. This module is really intended to be the layer between the consumer and the implementation details. Ideally the implementation details can change any way they like, and this module can be updated to use the new details without breaking anything.

Test2::API::Instance

the Test2::API::Instance manpage is where the global state is actually managed. This is an implementation detail, and should not be relied upon. It is entirely possible that the Test2::API::Instance manpage could be removed completely, or changed in incompatible ways. Really these details are free to change so long as the Test2::API manpage is not broken.

the Test2::API::Instance manpage is fairly well documented, so no additionally documentation is needed for this manual page.

SEE ALSO

the Test2::Manual manpage - Primary index of the manual.

SOURCE

The source code repository for Test2-Manual can be found at https://github.com/Test-More/Test2-Suite/.

MAINTAINERS

Chad Granum

AUTHORS

Chad Granum <exodist@cpan.org>Chad Granum

COPYRIGHT

Copyright 2018 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 http://dev.perl.org/licenses/