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.

Sign up for GitHub

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

Jump to bottom

Rename more message args #799

Merged
merged 12 commits into from
Oct 12, 2020
Merged

Rename more message args #799

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fde74e2
Fix message arg name mismatch
mattias-p Oct 2, 2020
b64d7f3
Rename message arg: addrs
mattias-p Oct 2, 2020
e4a87f1
Rename message arg: servers
mattias-p Oct 2, 2020
ee9076a
Rename message arg: glue
mattias-p Oct 2, 2020
00e719f
Rename message args: parent_addresses, zone_addresses
mattias-p Oct 2, 2020
00a844e
Rename message arg: addresses
mattias-p Oct 2, 2020
6820639
Refactor
mattias-p Oct 5, 2020
bda4006
Rename message arg: nsset
mattias-p Oct 5, 2020
02189bd
Rename message arg: names
mattias-p Oct 5, 2020
63228ac
Clarify usage of suffixes
mattias-p Oct 6, 2020
0a2c1a6
Revert suffixed argument names
mattias-p Oct 8, 2020
bf127cf
Rename nssset argument
mattias-p Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/logentry_args.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

## Aggregate list

| Argument | Type of value | Description and formatting |
This table contains prefixes of argument names. An optional suffix may be added
for disambiguation and/or clarity.
Suffixes must be in snake_case, they must start with an underscore, and it must
be unambiguous from the table where the base name ends and where the suffix
begins.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have changed this document from a list of defined argument names to something more complex that includes something called "base name" and some kind of rules for suffixing, which means that a name has some kind of morphology or syntax.

I prefer if this is a list defined argument names, i.e. names without formal internal structure. At least as a start.

If you go the second way, some terms must be defined and the rules must be specified. Still, the suffixes or prefixes must be listed and defined. It must be possible, as a translator, to go into the list and find the argument name and figure out what kind of data it is.


| Base name | Type of value | Description and formatting |
|-------------|----------------------|-------------------------------------------------------------|
| nsname | Domain name | The domain name of a name server. |
| ns_ip | IP address | The IP address of a name server. |
Expand Down