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

Meta data from .pod file #14

Closed
ronww opened this issue Mar 26, 2015 · 7 comments
Closed

Meta data from .pod file #14

ronww opened this issue Mar 26, 2015 · 7 comments

Comments

@ronww
Copy link

ronww commented Mar 26, 2015

Please support reading the meta data from the .pod file, not just the .pm file. Maybe have a --pod option to request this.

@Leont
Copy link
Owner

Leont commented Mar 26, 2015

It would seem reasonable to prefer .pod over .pm, if you wouldn't want to use that it wouldn't be there.

@Leont
Copy link
Owner

Leont commented Mar 25, 2016

This is actually more tricky than expected, because some metadata ($VERSION in particular) always needs to come from the .pm file, but other metadata could come from both.

@ronww
Copy link
Author

ronww commented Mar 26, 2016

Yes, I ran into that while testing possible proposals for code changes.

While I've come up with a working scheme for "falling back" on the pm file
for missing information, I've been hesitant to propose it.

In my situation, I'm working on generating POD from special comments -
comments similar to what Perl6 provides. Of course, it still makes sense to
include some POD in the pm file, which is just passed through as-is.

So, I've been working to enhance my POD generator to extract information
information from POD in the pm file.

That does lead to another to another idea I might propose. Still working on
a demonstration.

On Fri, Mar 25, 2016 at 3:04 PM, Leon Timmermans notifications@github.com
wrote:

This is actually more tricky than expected, because some metadata (
$VERSION in particular) always needs to come from the .pm file, but other
metadata could come from both.


You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
#14 (comment)

@jberger
Copy link
Contributor

jberger commented Mar 26, 2016

I don't understand what information you would want to extract from a .pod file if the .pm is present. Could you give an example? Also since the addition of the metamerge file it can be much easier to tweak up the discovered data with your own data.

@ronww
Copy link
Author

ronww commented Mar 28, 2016

On Sat, Mar 26, 2016 at 3:18 PM, Joel Berger notifications@github.com
wrote:

I don't understand what information you would want to extract from a .pod
file if the .pm is present. Could you give an example? Also since the
addition of the metamerge file it can be much easier to tweak up the
discovered data with your own data.

For various reasons, some projects put the documentation in a separate pod
file. Since some of the information extracted by mbtiny (and other similar
tools) is in the "pod comments", then if the POD is in a separate pod file,
then that file needs to be scanned.

Thinking more, it occurs to me that, in the general case, supporting a
separate pod file will require scanning both the pm and the pod files. I
can clean up and submit my proposed enhancement to App::ModuleBuildTiny to
support this.

For my situation, I could generate a metamerge.json file along side
generating the pod file. I do, however, wonder which other "distribution
build tools" also support metamerge and how.

@Leont
Copy link
Owner

Leont commented Mar 30, 2016

I do, however, wonder which other "distribution build tools" also support metamerge and how.

They don't.

@Leont Leont added the hacktober label Oct 2, 2018
@Leont
Copy link
Owner

Leont commented Feb 11, 2023

This has been fixed in 0.034

@Leont Leont closed this as completed Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants