PERLANCAR / SortExample-0.1.1 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

              
NAME
    SortExample - Sort examples
SPECIFICATION VERSION
    0.1
VERSION
    This document describes version 0.1.1 of SortExample (from Perl
    distribution SortExample), released on 2024-01-27.
SYNOPSIS
    Basic use with Sort::ByExample:
     use Sort::ByExample qw(sbe);
     use SortExample::AHMS::Fruit::EN; # list of fruit by decreasing priority/popularity
     my @sorted = sbe(SortExample::AHMS::Fruit::EN::get_example(), "peach", "grape", "strawberry");
     # => ("strawberry", "grape", "peach");
    Specifying arguments:
     use Sort::ByExample qw(sbe);
     use SortExample::Foo;
     my @sorted = sbe(SortExample::Foo::get_example(arg1=>..., ), ...);
    Specifying example on the command-line (for other CLI's):
     % sort-by-example -m AHMS::Fruit::EN ...
     % sort-by-example -m Foo=arg1,val,arg2,val ...
DESCRIPTION
    EXPERIMENTAL.
    "SortExample" is a namespace for modules that declare sort examples.
    Sort examples are used with Sort::ByExample.
  Writing a SortExample module
     package SortExample::Foo;
     # required. must return a hash (DefHash)
     sub meta {
         return +{
             v => 1,
             summary => 'Sort examples related to Foo',
             args => {
                 arg1 => {
                     schema => 'str*', # Sah schema
                     req => 1,
                 },
             },
         };
     }
     sub get_example {
         my %args = @_;
         ...
         return [...];
     }
     1;
  Namespace organization
    TODO.
  SEE ALSO
  Base specifications
    DefHash
    Sah
  Related specifications
    SortSpec
  Related modules
    Sort::ByExample
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/SortExample>.
SOURCE
    Source repository is at <https://github.com/perlancar/perl-SortExample>.
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 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=SortExample>
    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.