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

Add metadata to each program #8

Merged
merged 1 commit into from
Oct 4, 2014
Merged

Add metadata to each program #8

merged 1 commit into from
Oct 4, 2014

Conversation

timgimyee
Copy link
Contributor

Issue #4.

briandfoy added a commit that referenced this pull request Oct 4, 2014
Add metadata to each program
@briandfoy briandfoy merged commit 2e41959 into briandfoy:master Oct 4, 2014
@kentfredric
Copy link

It has come to my attention that this POD in this pull request is formatted incorrectly.

According to POD spec,

   That is, with "=for", you can have only one paragraph's worth of text
   (i.e., the text in "=foo targetname text..."), but with "=begin
   targetname" ... "=end targetname", you can have any amount of stuff in
   between. (Note that there still must be a blank line after the
   "=begin" command and a blank line before the "=end" command.)

So that means the following:

=for foo

bar

=cut

Is parsed as:

{ type => "for", formatname => "foo", text => "" }
{ type => "text", text => "bar" }
{ type => "cut" }

Where what you meant to do was

=begin foo

bar

=end foo

=cut

Which communicates:

{ type => "begin", formatname => "foo", text=>"bar\n" }
{ type => "cut" }

Subsequently, this mistake renders the "metadata" as actual documentation:

https://metacpan.org/pod/touch

Because a "blank event" ( ie: a line without content ) marks the end of the "Paragraph" which is the "=for" directive.

@ghost ghost mentioned this pull request Oct 28, 2016
@briandfoy briandfoy added Type: documentation fix the docs Status: released there is a new release with this fix labels Jul 11, 2023
@briandfoy briandfoy self-assigned this Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: released there is a new release with this fix Type: documentation fix the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants