Add checking for main module's separate .pod file #2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I'm using Pod2Readme via the Starter bundle, and was surprised to discover that it was producing an empty README file. My main module's pod source is in a separate .pod file alongside the .pm file. I used the source_filename parameter to specify the .pod file and it worked, but I didn't think I should need to do that (since I don't need to specify the main module anywhere else in dist.ini). My understanding is that a separate .pod file is a reasonably normal thing to do.
So this patch makes Pod2Readme check for the existence of a separate .pod file for the main module, and uses that as the source instead without requiring the user to resort to an explicit source_filename parameter.