Document the ProductOpener::URL.pm module #3046
Merged
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
Documentation in perlpod format
lib/ProductOpener/URL.pm
Outdated
|
|
||
| =head3 Arguments | ||
|
|
||
| A scalar variable needs to be passed as an argument. |
There was a problem hiding this comment.
In addition to its type, we need to indicate was the argument is.
Suggested change
| A scalar variable needs to be passed as an argument. | |
| A scalar variable to indicate the subdomain (e.g. "us" or "static") needs to be passed as an argument. |
There was a problem hiding this comment.
Same for the other functions.
stephanegigandet
requested changes
Mar 16, 2020
|
@stephanegigandet I've made the suggested changes. Does it look fine now? |
stephanegigandet
approved these changes
Mar 16, 2020
teolemon
added
the
📚 Documentation
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.
Description:
Documentation of the ProductOpener::URL.pm module in perlpod format
Related issues and discussion:
fixes #3044
#2203