Skip to content
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

Merged
merged 2 commits into from
Nov 19, 2021
Merged

Conversation

matsduf
Copy link
Contributor

@matsduf matsduf commented Nov 5, 2021

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:

  • 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

How to test this PR

This is document only, but the new method is already used in #995.

* 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
@matsduf matsduf added A-TestCase Area: Test case specification or implementation of test case A-Documentation Area: Documentation only. labels Nov 5, 2021
@matsduf matsduf added this to the v2021.2 milestone Nov 5, 2021
docs/logentry_args.md Outdated Show resolved Hide resolved
Comment on lines 7 to 8
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].
Copy link
Member

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.

Copy link
Contributor Author

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".

docs/logentry_args.md Outdated Show resolved Hide resolved
docs/logentry_args.md Outdated Show resolved Hide resolved
docs/logentry_args.md Outdated Show resolved Hide resolved
* Some editorial updates
* Consistent use "message"
* Consistent definition of "argument"
Copy link
Contributor Author

@matsduf matsduf left a 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 Show resolved Hide resolved
Comment on lines 7 to 8
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].
Copy link
Contributor Author

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".

docs/logentry_args.md Outdated Show resolved Hide resolved
docs/logentry_args.md Outdated Show resolved Hide resolved
docs/logentry_args.md Outdated Show resolved Hide resolved
@matsduf
Copy link
Contributor Author

matsduf commented Nov 10, 2021

@mattias-p and @vlevigneron, can you (re-)review this?

@matsduf
Copy link
Contributor Author

matsduf commented Nov 12, 2021

@vlevigneron, does this looks good to you?

@matsduf matsduf merged commit fe4c8ae into zonemaster:develop Nov 19, 2021
@matsduf matsduf deleted the update-argument-list branch November 19, 2021 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation only. A-TestCase Area: Test case specification or implementation of test case
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants