NAME

Perinci::Manual::HowTo::FunctionMetadata - How-to guides related to function metadata

VERSION

This document describes version 0.010 of Perinci::Manual::HowTo::FunctionMetadata (from Perl distribution Perinci-Manual), released on 2022-07-22.

DESCRIPTION

Hiding Argument

To make an argument "hidden", you can add either a hidden, hidden-cli, or hidden-mod to the tags property. This will have the following effects:

• Perinci::To::POD (as well as its sisters like Perinci::To::Text, Perinci::To::HTML) will not list the argument in the generated documentation

  This is for hidden or hidden-mod tag.

• Perinci::Sub::To::CLIDocData (which is used by Perinci::CmdLine) will not list the arguments in the CLI documentation as well as --help message

  This is for hidden or hidden-cli tag.

So with hidden-cli or hidden-mod you can hide arguments from CLI-only or module POD only.

Hiding Function

To make a function "hidden", you can set x.no_index attribute to true, or add a hidden tag to the tags property. This will have the following effects:

• Perinci::To::POD (as well as its sisters like Perinci::To::Text, Perinci::To::HTML) will not list the function in the generated documentation

  If you use the Pod::Weaver plugin Pod::Weaver::Plugin::Rinci, the generated POD documentation for your module will also skip the function, making the function undocumented in the POD.

• Perinci::Access::Schemeless, Perinci::Access::Perl, as well as other Perinci::Access::* modules which uses the former (like Perinci::Access::HTTP::Server) will not list the function

  When you issue a list CRiap request to one of these modules, the function will not be listed in the package it is in.

Keywords: undocumented, documentation

HOMEPAGE

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

SOURCE

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

SEE ALSO

More specific how-to guides can be found in Perinci::Manual::HowTo::FunctionMetadata::XXX, e.g. Perinci::Manual::HowTo::FunctionMetadata::Examples

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021 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-Manual

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.

cpanm Perinci::Manual

perl -MCPAN -e shell
install Perinci::Manual