{
    "content": [
        {
            "type": "text",
            "text": "# Test2::EventFacet::Plan (perldoc)\n\n**Summary:** Test2::EventFacet::Plan - Facet for setting the plan\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **DESCRIPTION** (2 lines)\n- **FIELDS** (23 lines)\n- **SOURCE** (2 lines)\n- **MAINTAINERS** (2 lines)\n- **AUTHORS** (2 lines)\n- **COPYRIGHT** (7 lines)\n\n## Full Content\n\n### NAME\n\nTest2::EventFacet::Plan - Facet for setting the plan\n\n### DESCRIPTION\n\nEvents use this facet when they need to set the plan.\n\n### FIELDS\n\n$string = $plan->{details}\n$string = $plan->details()\nHuman readable explanation for the plan being set. This is normally not rendered by most\nformatters except when the \"skip\" field is also set.\n\n$positiveint = $plan->{count}\n$positiveint = $plan->count()\nSet the number of expected assertions. This should usually be set to 0 when \"skip\" or \"none\"\nare also set.\n\n$bool = $plan->{skip}\n$bool = $plan->skip()\nWhen true the entire test should be skipped. This is usually paired with an explanation in\nthe \"details\" field, and a \"control\" facet that has \"terminate\" set to 0.\n\n$bool = $plan->{none}\n$bool = $plan->none()\nThis is mainly used by legacy Test::Builder tests which set the plan to \"no plan\", a\nconstruct that predates the much better \"donetesting()\".\n\nIf you are using this in non-legacy code you may need to reconsider the course of your life,\nmaybe a hermitage would suite you?\n\n### SOURCE\n\nThe source code repository for Test2 can be found at http://github.com/Test-More/test-more/.\n\n### MAINTAINERS\n\nChad Granum <exodist@cpan.org>\n\n### AUTHORS\n\nChad Granum <exodist@cpan.org>\n\n### COPYRIGHT\n\nCopyright 2020 Chad Granum <exodist@cpan.org>.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n\nSee http://dev.perl.org/licenses/\n\n"
        }
    ],
    "structuredContent": {
        "command": "Test2::EventFacet::Plan",
        "section": "",
        "mode": "perldoc",
        "summary": "Test2::EventFacet::Plan - Facet for setting the plan",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FIELDS",
                "lines": 23,
                "subsections": []
            },
            {
                "name": "SOURCE",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "MAINTAINERS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHORS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 7,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Test2::EventFacet::Plan - Facet for setting the plan\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Events use this facet when they need to set the plan.\n",
                "subsections": []
            },
            "FIELDS": {
                "content": "$string = $plan->{details}\n$string = $plan->details()\nHuman readable explanation for the plan being set. This is normally not rendered by most\nformatters except when the \"skip\" field is also set.\n\n$positiveint = $plan->{count}\n$positiveint = $plan->count()\nSet the number of expected assertions. This should usually be set to 0 when \"skip\" or \"none\"\nare also set.\n\n$bool = $plan->{skip}\n$bool = $plan->skip()\nWhen true the entire test should be skipped. This is usually paired with an explanation in\nthe \"details\" field, and a \"control\" facet that has \"terminate\" set to 0.\n\n$bool = $plan->{none}\n$bool = $plan->none()\nThis is mainly used by legacy Test::Builder tests which set the plan to \"no plan\", a\nconstruct that predates the much better \"donetesting()\".\n\nIf you are using this in non-legacy code you may need to reconsider the course of your life,\nmaybe a hermitage would suite you?\n",
                "subsections": []
            },
            "SOURCE": {
                "content": "The source code repository for Test2 can be found at http://github.com/Test-More/test-more/.\n",
                "subsections": []
            },
            "MAINTAINERS": {
                "content": "Chad Granum <exodist@cpan.org>\n",
                "subsections": []
            },
            "AUTHORS": {
                "content": "Chad Granum <exodist@cpan.org>\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright 2020 Chad Granum <exodist@cpan.org>.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n\nSee http://dev.perl.org/licenses/\n",
                "subsections": []
            }
        }
    }
}