Document and update method '_emit_log()' in all Test modules#1310
Merged
tgreenx merged 1 commit intozonemaster:developfrom Dec 4, 2023
Merged
Document and update method '_emit_log()' in all Test modules#1310tgreenx merged 1 commit intozonemaster:developfrom
tgreenx merged 1 commit intozonemaster:developfrom
Conversation
tgreenx
requested review from
a user,
hannaeko,
marc-vanderwal,
matsduf and
mattias-p
- Move '_emit_log()' to the proper section in each Test modules - Add documentation for '_emit_log()' in each Test modules - Align implementation of 'Zonemaster::Engine::Test::Basic::_emit_log()' with its counterpart from other Test modules - Make 'Zonemaster::Engine::Test::Address::find_private_address()' an internal method
tgreenx
force-pushed
the
update-emit_log
branch
from
e572099 to
65a62a8
Compare
ghost
approved these changes
Nov 30, 2023
ghost
left a comment
ghost
left a comment
There was a problem hiding this comment.
LGTM, just a tiny suggestion. But this could work without it.
|
|
||
| Takes a string (message tag) and a reference to a hash (arguments). | ||
|
|
||
| Returns a L<Zonemaster::Engine::Logger::Entry> object. |
There was a problem hiding this comment.
Suggestion: specify that the entry is defined with the Address testcase value or something like that so that it is clear that this internal method is different in each module.
hannaeko
approved these changes
Dec 1, 2023
matsduf
approved these changes
Dec 1, 2023
hannaeko
added
the
S-ReleaseTested
This file contains hidden or 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
3 participants
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.
Purpose
This PR documents and updates the recently added
_emit_log()internal method. See the Changes section below.Context
#1302
Changes
How to test this PR
Tests should pass.
POD documentation should show correctly, e.g. using pod2text.