App::lcpan::Cmd::most_mentioned_scripts - Alias for 'scripts-by-mention-count', with default n=100
This document describes version 1.068 of App::lcpan::Cmd::most_mentioned_scripts (from Perl distribution App-lcpan), released on 2021-06-05.
Usage:
handle_cmd(%args) -> [$status_code, $reason, $payload, \%result_meta]
Alias for 'scripts-by-mention-count', with default n=100.
This shows the list of most mentioned scripts, that is, scripts who are linked/referred to the most in PODs.
By default, each source module/script that mentions a script is counted as one mention (--count-per content). Use --count-per dist to only count mentions by modules/scripts from the same dist as one mention (so a script only gets a maximum of 1 vote per dist). Use --count-per author to only count mentions by modules/scripts from the same author as one mention (so a script only gets a maximum of 1 vote per mentioning author).
--count-per content
--count-per dist
--count-per author
By default, only mentions from other authors are included. Use --include-self-mentions to also include mentions from the same author.
--include-self-mentions
This function is not exported.
Arguments ('*' denotes required arguments):
count_per => str (default: "content")
cpan => dirname
Location of your local CPAN mirror, e.g. /path/to/cpan.
Defaults to ~/cpan.
~/cpan
include_self_mentions => bool (default: 0)
index_name => filename (default: "index.db")
Filename of index.
If index_name is a filename without any path, e.g. index.db then index will be located in the top-level of cpan. If index_name contains a path, e.g. ./index.db or /home/ujang/lcpan.db then the index will be located solely using the index_name.
index_name
index.db
cpan
./index.db
/home/ujang/lcpan.db
n => posint (default: 100)
Return at most this number of results.
use_bootstrap => bool (default: 1)
Whether to use bootstrap database from App-lcpan-Bootstrap.
If you are indexing your private CPAN-like repository, you want to turn this off.
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/App-lcpan.
Source repository is at https://github.com/perlancar/perl-App-lcpan.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-lcpan
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016, 2015 by 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.
To install App::lcpan, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::lcpan
CPAN shell
perl -MCPAN -e shell install App::lcpan
For more information on module installation, please visit the detailed CPAN module installation guide.