-
Notifications
You must be signed in to change notification settings - Fork 33
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
Updates logentry_args.md #997
Conversation
* Updates the headline * Adds an introduction and some specification * Splits the table into two tables, defined and not yet defined names * Removes old list not relevant
docs/logentry_args.md
Outdated
Zonemaster messages. The messages are defined in the Perl modules for the test | ||
cases, e.g. [Basic.pm], and translated in the PO files, e.g. [fr.po] and [sv.po]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some messages are also defined in Zonemaster::Engine::Translator.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I should have checked. I changed to "are primarily defined in".
* Some editorial updates * Consistent use "message" * Consistent definition of "argument"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When working on the text, I realized that "message" and "argument" could be used consistently. I have done further updates.
docs/logentry_args.md
Outdated
Zonemaster messages. The messages are defined in the Perl modules for the test | ||
cases, e.g. [Basic.pm], and translated in the PO files, e.g. [fr.po] and [sv.po]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I should have checked. I changed to "are primarily defined in".
@mattias-p and @vlevigneron, can you (re-)review this? |
@vlevigneron, does this looks good to you? |
Purpose
logentry_args.md
defines argument names to be used in messages, but there is a limitation in the message model. An argument name can only be used once in the same message. This PR specifies a method to extend the name for such cases.This PR also:
How to test this PR
This is document only, but the new method is already used in #995.