Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pod::To::Text is mishandling footnotes. #2711

Open
cfa opened this issue Feb 20, 2019 · 0 comments
Open

Pod::To::Text is mishandling footnotes. #2711

cfa opened this issue Feb 20, 2019 · 0 comments
Labels

Comments

@cfa
Copy link

cfa commented Feb 20, 2019

The Problem

Footnote codes (N<>) are incorrectly handled by Pod::To::Text. Given

=begin pod
TestN<note>.
=end pod

perl6 --doc outputs: “Testnote.”

Expected Behavior

Any of the following would make sense:

  1. List footnotes at the end of the document, cross referenced from the source site;
  2. List footnotes in place, perhaps in parentheses: “Test (FOOTNOTE: note)”;
  3. As a temporary measure, at least distinguish a footnote by prepending whitespace.

Actual Behavior

The formatting code is simply stripped and the footnote joined directly to the immediately preceding text.

> use Pod::To::Text;
Nil
> my $pod = EVAL "\$=pod;\n=begin pod\nTestN<note>.\n=end pod";
[Pod::Block::Named{:name("pod")}
  Pod::Block::Para
    Test
    Pod::FormattingCode{:type("N")}
      note
    .
]
> pod2text $pod
Testnote.

Environment

This is Rakudo version 2018.12 built on MoarVM version 2018.12
implementing Perl 6.d.
cfa added a commit to Raku/doc that referenced this issue Feb 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants