Document the ProductOpener::Mail.pm module #5087
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
lib/ProductOpener/Mail.pm
Outdated
|
|
||
| =head3 Arguments | ||
|
|
||
| Two scalar varaibles that contain the email subject and body are passed as an argument. |
There was a problem hiding this comment.
Suggested change
| Two scalar varaibles that contain the email subject and body are passed as an argument. | |
| Two scalar variables that contain the email subject and body are passed as an argument. |
lib/ProductOpener/Mail.pm
Outdated
|
|
||
| =head3 Arguments | ||
|
|
||
| Two scalar varaibles that contain the email subject and body are passed as an argument. |
There was a problem hiding this comment.
Suggested change
| Two scalar varaibles that contain the email subject and body are passed as an argument. | |
| Two scalar variables that contain the email subject and body are passed as an argument. |
lib/ProductOpener/Mail.pm
Outdated
|
|
||
| =head2 send_email_to_producers_admin( SUBJECT, TEXT ) | ||
|
|
||
| C<send_email_to_producers_admin()> sends email from the contacts email of Open Food Facts to producers admin. |
There was a problem hiding this comment.
Suggested change
| C<send_email_to_producers_admin()> sends email from the contacts email of Open Food Facts to producers admin. | |
| C<send_email_to_producers_admin()> sends email from the contact email of Open Food Facts to producers admin. |
lib/ProductOpener/Mail.pm
Outdated
|
|
||
| =head3 Arguments | ||
|
|
||
| The first argument is a hash reference. The other two arguments are scalar varaibles that consist of email subject and body. |
There was a problem hiding this comment.
Suggested change
| The first argument is a hash reference. The other two arguments are scalar varaibles that consist of email subject and body. | |
| The first argument is a hash reference. The other two arguments are scalar variables that consist of email subject and body. |
CharlesNepote
requested changes
Apr 1, 2021
Thank you so much for your feedback!! I have incorporated changes. Please have a look! |
|
Kudos, SonarCloud Quality Gate passed!
|
stephanegigandet
approved these changes
Apr 1, 2021
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: Updated the
Mail.pmfile to add its documentation in perlpod format.Fixes: #5084
Related Issue: #2203