0.881 2023-07-09 Released-By: PERLANCAR; Urgency: medium
- No functional changes.
- Remove usage of smartmatch.
0.880 2022-10-15 Released-By: PERLANCAR; Urgency: medium
- [ux] In generated argument POD, use '(No description)' as
description when there is no argument summary or description.
0.879 2022-05-14 Released-By: PERLANCAR; Urgency: low
- No functional changes.
- [doc] Mention gen-pod-for-pericmd-script.
0.878 2021-05-31 Released-By: PERLANCAR; Urgency: medium
- Remove leading indentation in single-line argument dump.
0.877 2021-05-24 Released-By: PERLANCAR; Urgency: medium
- Tweak generated subroutine result documentation some more.
0.876 2021-05-23 Released-By: PERLANCAR; Urgency: medium
- Tweak generated subroutine result documentation.
0.875 2021-02-21 Released-By: PERLANCAR; Urgency: medium
- Remove debug print.
0.874 2020-10-20 Released-By: PERLANCAR; Urgency: medium
- Fix the naked/enveloped result bug once and for all (I hope).
0.873 2020-10-07 Released-By: PERLANCAR; Urgency: medium
- Observe env_result & naked_result function example specification.
Rinci 1.1.94 defines env_result & naked_result, and unlike
Test::Rinci, this module did not consider these function example
specification's properties.
0.872 2020-04-27 Released-By: PERLANCAR; Urgency: medium
- When function metadata property 'args_as' is array(ref)?,
arguments that are not positional (do not define 'pos' argument
metadata property) can be specified as the first hashref; the
hashref is optional if all those non-positional arguments are
optional.
0.871 2020-04-16 Released-By: PERLANCAR; Urgency: medium
- Do not add function's prog: links to module's See Also because
they are normally irrelevant.
0.870 2020-01-31 Released-By: PERLANCAR; Urgency: medium
- [bugfix] Fix misplaced parenthesis which caused perl undef
warning.
0.869 2020-01-28 Released-By: PERLANCAR; Urgency: medium
- [bugfix] Forgot to shift self.
0.868 2020-01-28 Released-By: PERLANCAR; Urgency: medium
- Also observe the 'hidden' tag for function metadata (in addition
to function argument metadata).
- Use String::PodQuote to quote summary when added into POD.
0.867 2019-07-26 Released-By: PERLANCAR; Urgency: medium
- Fix indentation of first argument.
0.866 2019-04-15 Released-By: PERLANCAR
- Update to Rinci 1.1.88 (slurpy).
0.865 2019-04-08 Released-By: PERLANCAR
- Separate methods to METHODS section.
0.864 2018-10-10 Released-By: PERLANCAR
- Change terminology result -> payload in enveloped result.
0.863 2018-09-10 Released-By: PERLANCAR
- Observe 'doc' example property to allow skipping POD rendering.
0.862 2017-12-09 Released-By: PERLANCAR
- Update to Rinci 1.1.86 (don't require all example result to be
enveloped).
0.861 2017-10-26 Released-By: PERLANCAR
- Follow specification Rinci 1.1.85 (example's result is always in
enveloped form).
0.860 2017-08-12 Released-By: PERLANCAR
- Use description.alt.env.perl before description.
0.85 2017-07-03 Released-By: PERLANCAR
- No functional changes.
- Switch from Log::Any to Log::ger.
0.84 2017-02-27 Released-By: PERLANCAR
- [ux] Show number of snipped lines in long example output.
0.83 2017-02-24 Released-By: PERLANCAR
- Also observe example's x.doc.max_result_lines.
0.82 2017-02-03 Released-By: PERLANCAR
- [ux] Make the function headline just the function name instead of
with usage/return information, for easier addressability/linking.
Usage information is given in the first paragraph.
0.81 2016-10-27 Released-By: PERLANCAR
- Aside from 'hidden' tag, skip documenting argument if it has
'hidden-mod' tag.
0.80 2016-09-27 Released-By: PERLANCAR
- Aside from pm:, also replace autolink with pod: scheme with
L<...>.
0.79 2016-09-26 Released-By: PERLANCAR
- Recognize prog: URLs as well as pm:.
- Tweak metadata: replace x.schema.entity with schema.
- Formatting of generated Links POD section.
0.78 2016-04-18 Released-By: PERLANCAR
- In package's See Also POD section, also include links from each
function; don't render links as See Also paragraph for each
individual function: do it on a per-package basis.
- Also show non-pm: links in POD's See Also.
0.77 2016-03-02 Released-By: PERLANCAR
- Tweak wording in generated POD: 'This function is not exportable' ->
'This function is not exported'.
- Tweak generated POD: show argument as "$arg" instead of "arg" in POD
when args_as =~ /array/.
0.76 2016-02-26 Released-By: PERLANCAR
- Tweak whitespace stripping in rendering example's array args.
- peri-doc: Completion tweak/fix.
- [Bugfix] Didn't use _orig_args_as when constructing function
usage line.
0.75 2016-02-26 Released-By: PERLANCAR
[Bug fixes]
- When launching Riap 'call' request to functions to get example result,
didn't use full URL, so peri-doc fails to render example results.
- When getting function metadata, didn't use 'normalize_metadata'
setting of Perinci::Access, so we didn't get _orig_args_as &
_orig_result_naked keys. This caused rendering to be incorrect.
- peri-doc: Avoid dereference error when we only generate doc for a
single function.
- Don't show sub's export information if unknown. Previously peri-doc
showed 'not exported by default but exportable' but this might be
wrong depending on the package settings. Now by default we don't show
export information at all, unless export information is supplied in
the 'export' attribute.
0.74 2015-12-28 Released-By: PERLANCAR
- [ux] When rendering hash(ref) arguments in examples in POD, use
ordering from argument specification's 'pos' properties.
- Produce nicer coderef dumps in examples in POD by using
Data::Dump::SortKeys' 0.04 $REMOVE_PRAGMAS option.
0.73 2015-12-23 Released-By: PERLANCAR
- [experimental][ux] When rendering example's result in POD, use
hash key ordering from 'table.fields' result metadata if exists.
0.72 2015-12-18 Released-By: PERLANCAR
- More tweaks/fixes to formatting of examples (renders description).
0.71 2015-12-18 Released-By: PERLANCAR
- Tweak/fix formatting for examples.
0.70 2015-12-18 Released-By: PERLANCAR
- [Bugfix] Second attempt to really fix getting the correct value
of result_naked.
0.69 2015-12-17 Released-By: PERLANCAR
- [Bugfix] Get the correct (original) value of result_naked and
args_as properties.
- Bump prereq version Log::Any::IfLOG to 0.07.
0.68 2015-09-29 Released-By: PERLANCAR
- Show function's export behavior (exported by default, not
exported by default but exportable, never exported).
0.67 2015-09-26 Released-By: PERLANCAR
- Don't duplicate documentation for alias function, just say that
the function is 'alias for ORIG'.
0.66 2015-09-25 Released-By: PERLANCAR
- Don't show non-perl examples in POD function documentation.
0.65 2015-09-25 Released-By: PERLANCAR
- Observe example spec's x.doc.show_result.
0.64 2015-09-23 Released-By: PERLANCAR
- If example specification does not specify result, get result by
calling the function (through Riap).
- [Bugfix] Don't modify original example's argv.
0.63 2015-09-04 Released-By: PERLANCAR
- No functional changes.
- [dist] Move spec prereqs from RuntimeRequires to
DevelopRecommends to reduce deps but still allow indicating spec
requirement.
0.62 2015-08-18 Released-By: PERLANCAR
- No functional changes.
- Switch from Log::Any to Log::Any::IfLOG.
0.61 2015-07-07 Released-By: PERLANCAR
- Skip including function in doc if x.no_index=1.
- Update URL syntax (pm:MODULE instead of pm://MODULE).
- Adjust to Perinci::CmdLine -> Perinci::CmdLine::Classic rename,
respect 'hidden' tag to skip listing the argument.
0.60 2015-01-05 Released-By: PERLANCAR
- [Bugfix] Regression: forgot to add a blank line which causes next
POD directive to be not interpreted during pod weaving.
0.59 2015-01-02 Released-By: PERLANCAR
- Remove Perinci::ToUtil and use Data::Sah::Terse, tweak POD:
function result.
0.58 2014-12-11 Released-By: PERLANCAR
- Add missing dep.
- Move roles from SHARYANTO-Role-Doc-* to Perinci-To-Doc-Role-*.
0.57 2014-11-29 Released-By: SHARYANTO
- Render function and package links in POD (currently only for pm:
urls).
- A couple of bug fixes.
0.56 2014-07-22 Released-By: SHARYANTO
- Display pos arguments nicer: 'func($a, $b, ...)' instead of
'func(@args)'.
0.55 2014-07-20 Released-By: SHARYANTO
- No functional changes.
- Adjust to Markdown::To::POD 0.02.
0.54 2014-07-20 Released-By: SHARYANTO
- Replace Markdown::Pod with Markdown::To::POD (which has lower startup
overhead and does not have the annoying 'a_b and c_d' -> 'aI<b and
c>d' rendering bug).
0.53 2014-07-18 Released-By: SHARYANTO
- Show function result description in POD.
- [Bugfix] Fix showing function result type in POD even when result
summary is empty.
0.52 2014-07-18 Released-By: SHARYANTO
[ENHANCEMENTS]
- Observe 'args_as' property when showing function examples.
0.51 2014-05-01 Released-By: SHARYANTO
- [Bugfix] missed blank line (sigh, keeps happening, will refactor
later to avoid this in the future).
0.50 2014-04-30 Released-By: SHARYANTO
- Adjust to Perinci::Access::Perl 0.66 (use normalize_metadata option
instead of orig_meta in result metadata).
- Show result summary and schema.
0.49 2014-04-10 Released-By: SHARYANTO
- No functional changes.
- Replace List::MoreUtils with Function::Fallback::CoreOrPP.
0.48 2014-04-04 Released-By: SHARYANTO
[BUG FIXES]
- Several fixes.
0.47 2014-03-28 Released-By: SHARYANTO
[BUG FIXES]
- Fix bug in package POD generation (missing blank line after
function result paragraph).
0.46 2014-03-21 Released-By: SHARYANTO
[BUG FIXES]
- Fix bug in package POD generation (missing blank line between
function's '=head2').
0.45 2014-03-21 Released-By: SHARYANTO
[ENHANCEMENTS]
- bin/peri-doc: Support formats 'pod' and 'html'.
0.44 2014-03-21 Released-By: SHARYANTO
[BUG FIXES]
- Translation of result description in POD.
0.43 2014-03-21 Released-By: SHARYANTO
- No functional changes.
- Remove POD references to old scripts.
0.42 2014-01-22 Released-By: SHARYANTO
[BUG FIXES]
- Function argument's summary/description were using function's
summary/description due to wrong variable used.
[REMOVED FEATURES]
- Remove deprecated scripts 'peri-func-doc' and 'peri-pkg-doc'.
0.41 2013-12-13 Released-By: SHARYANTO
- No functional changes. Mark 'peri-func-doc' and 'peri-pkg-doc' as
deprecated in favor of 'peri-doc'. I was lazy back then and created
two separate commands for my convenience, but it was convenient for
users to have a single command.
0.40 2013-12-13 Released-By: SHARYANTO
- No functional changes. Use Locale::TextDomain::UTF8.
0.39 2013-12-13 Released-By: SHARYANTO
- No functional changes. Use a single Locale::TextDomain textdomain for
the distribution.
0.38 2013-12-12 Released-By: SHARYANTO
- First release. Merged several distributions into one
(Perinci-Sub-To-Text, Perinci-To-Text, Perinci-Sub-To-POD,
Perinci-To-POD) because they are closely related to one another and
used to break each other when put as separate dists.
- Switch from Locale::Maketext to Locale::TextDomain.