Debian Codegraph @

lib/Rinci/variable.pod

raw
1 package Rinci::variable; # just to make PodWeaver happy
2
3 # AUTHORITY
4 # DATE
5 our $DIST = 'Rinci'; # DIST
6 # VERSION
7
8 1;
9 # ABSTRACT: Metadata for your variables
10
11 __END__
12
13 =pod
14
15 =encoding UTF-8
16
17 =head1 NAME
18
19 Rinci::variable - Metadata for your variables
20
21 =head1 SPECIFICATION VERSION
22
23 1.1
24
25 =head1 VERSION
26
27 This document describes version 1.1.104 of Rinci::variable (from Perl distribution Rinci), released on 2023-09-30.
28
29 =head1 INTRODUCTION
30
31 This document describes metadata for variables. This specification is part of
32 L<Rinci>. Please do a read up on it first, if you have not already done so.
33
34 =head1 SPECIFICATION
35
36 There is currently no metadata properties specific to variables.
37
38 =head2 Property: schema => SCHEMA
39
40 Specify the Sah schema that the variable's value must validate to. This can be
41 used by a variable wrapper (getter/setter generator) tool to make sure that
42 variable always contains valid values.
43
44 Example:
45
46 # metadata for variable $Meaning_Of_Life
47 {
48 ...
49 summary => 'The meaning of life',
50 schema => [int => {between => [1, 100]},
51 }
52
53 =head1 FAQ
54
55 =head1 HOMEPAGE
56
57 Please visit the project's homepage at L<https://metacpan.org/release/Rinci>.
58
59 =head1 SOURCE
60
61 Source repository is at L<https://github.com/perlancar/perl-Rinci>.
62
63 =head1 SEE ALSO
64
65 L<Rinci>
66
67 =head1 AUTHOR
68
69 perlancar <[email protected]>
70
71 =head1 CONTRIBUTING
72
73
74 To contribute, you can send patches by email/via RT, or send pull requests on
75 GitHub.
76
77 Most of the time, you don't need to build the distribution yourself. You can
78 simply modify the code, then test via:
79
80 % prove -l
81
82 If you want to build the distribution (e.g. to try to install it locally on your
83 system), you can install L<Dist::Zilla>,
84 L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
85 L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
86 Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
87 that are considered a bug and can be reported to me.
88
89 =head1 COPYRIGHT AND LICENSE
90
91 This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 by perlancar <[email protected]>.
92
93 This is free software; you can redistribute it and/or modify it under
94 the same terms as the Perl 5 programming language system itself.
95
96 =head1 BUGS
97
98 Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Rinci>
99
100 When submitting a bug or request, please include a test-file or a
101 patch to an existing test-file that illustrates the bug or desired
102 feature.
103
104 =cut