/ 
Perinci-To-Doc-0.881
River stage one • 3 direct dependents • 5 total dependents
/ Perinci::To::Doc::Role::Section::AddTextLines

NAME

Perinci::To::Doc::Role::Section::AddTextLines - Provide add_doc_lines() to add text with optional text wrapping

VERSION

This document describes version 0.881 of Perinci::To::Doc::Role::Section::AddTextLines (from Perl distribution Perinci-To-Doc), released on 2023-07-09.

DESCRIPTION

This role provides add_doc_lines() which can add optionally wrapped text to doc_lines.

The default column width for wrapping is from COLUMNS environment variable, or 80.

REQUIRES

These methods are provided by, e.g. Perinci::To::Doc::Role::Section.

$o->doc_lines()

$o->doc_indent_level()

$o->doc_lines_str()

ATTRIBUTES

doc_wrap => BOOL (default: 1)

Whether to do text wrapping.

METHODS

$o->add_doc_lines([\%opts, ]@lines)

Add lines of text, optionally wrapping each line if wrapping is enabled.

Available options:

  • wrap => BOOL

    Whether to enable wrapping. Default is from the doc_wrap attribute.

ENVIRONMENT

COLUMNS => INT

Used to set column width.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-To-Doc.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-To-Doc.

SEE ALSO

Perinci::To::Doc::Role::Section

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-To-Doc

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.