view release on metacpan or  search on metacpan

lib/Acme/CPANModules/DescribeAModuleBadly.pm  view on Meta::CPAN

package Acme::CPANModules::DescribeAModuleBadly;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-10-29'; # DATE
our $DIST = 'Acme-CPANModules-DescribeAModuleBadly'; # DIST
our $VERSION = '0.002'; # VERSION

our $LIST = {
    summary => 'List of modules that are described badly (meta)',
    description => <<'_',

`Acme::CPANModules::DescribeAModuleBadly::*` modules should contain lists of
modules that are being described badly. Inspired by Jimmy Fallon's Twitter
hashtag #DescribeAMovieBadly (Feb 4, 2020), the idea is to give an accurate
description of a certain element or aspect of the module but somehow miss the
whole point of it.

_
    entries => [
        {module=>'Acme::CPANModules::DescribeAModuleBadly::PERLANCAR'},
    ],
};

1;
# ABSTRACT: List of modules that are described badly (meta)

__END__

=pod

=encoding UTF-8

=head1 NAME

Acme::CPANModules::DescribeAModuleBadly - List of modules that are described badly (meta)

=head1 VERSION

This document describes version 0.002 of Acme::CPANModules::DescribeAModuleBadly (from Perl distribution Acme-CPANModules-DescribeAModuleBadly), released on 2023-10-29.

=head1 DESCRIPTION

C<Acme::CPANModules::DescribeAModuleBadly::*> modules should contain lists of
modules that are being described badly. Inspired by Jimmy Fallon's Twitter
hashtag #DescribeAMovieBadly (Feb 4, 2020), the idea is to give an accurate
description of a certain element or aspect of the module but somehow miss the
whole point of it.

=head1 ACME::CPANMODULES ENTRIES

=over

=item L<Acme::CPANModules::DescribeAModuleBadly::PERLANCAR>

Author: L<PERLANCAR|https://metacpan.org/author/PERLANCAR>

=back

=head1 FAQ

=head2 What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module
names that share a common characteristics. It is a way to categorize modules and
document CPAN. See L<Acme::CPANModules> for more details.

=head2 What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can
install all the listed modules (entries) using L<cpanm-cpanmodules> script (from
L<App::cpanm::cpanmodules> distribution):

 % cpanm-cpanmodules -n DescribeAModuleBadly

Alternatively you can use the L<cpanmodules> CLI (from L<App::cpanmodules>
distribution):

    % cpanmodules ls-entries DescribeAModuleBadly | cpanm -n

or L<Acme::CM::Get>:

    % perl -MAcme::CM::Get=DescribeAModuleBadly -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

    % perl -MAcme::CPANModules::DescribeAModuleBadly -E'say $_->{module} for @{ $Acme::CPANModules::DescribeAModuleBadly::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps L<lcpan> produce a more meaningful
result for C<lcpan related-mods> command when it comes to finding related
modules for the modules listed in this Acme::CPANModules module.
See L<App::lcpan::Cmd::related_mods> for more details on how "related modules"