/ 
Data-Sah-0.917
River stage three • 431 direct dependents • 689 total dependents
/ Data::Sah::Human

NAME

Data::Sah::Human - Some functions to use Data::Sah human compiler

VERSION

This document describes version 0.917 of Data::Sah::Human (from Perl distribution Data-Sah), released on 2024-02-16.

SYNOPSIS

use Data::Sah::Human qw(gen_human_msg);

say gen_human_msg(["int*", min=>2]); # -> "Integer, minimum 2"

DESCRIPTION

FUNCTIONS

None exported by default.

gen_human_msg($schema, \%opts) => STR (or ANY)

Compile schema using human compiler and return the result.

Known options (unknown ones will be passed to the compiler):

  • source => BOOL (default: 0)

    If set to true, will return raw compilation result.

ENVIRONMENT

LOG_SAH_VALIDATOR_CODE

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah.

SEE ALSO

Data::Sah, Data::Sah::Compiler::human.

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) 2024, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 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=Data-Sah

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.