Spelling by jsoref · Pull Request #1278 · zonemaster/zonemaster

jsoref · 2024-06-26T01:15:28Z

Purpose

Fixes misspellings identified by the check-spelling action.

Context

The misspellings have been reported at https://github.com/jsoref/zonemaster/actions/runs/9671895030#summary-26683304529

Changes

...

How to test this PR

The action will report that the changes in this PR would make it mostly happy: https://github.com/jsoref/zonemaster/actions/runs/9671895135#summary-26683304887

jsoref · 2024-06-26T01:19:15Z

 [Zonemaster product]
 - This version of Zonemaster also consists of the following components. For
-   each component, see its Changes file or Github release notes for complete
+   each component, see its Changes file or GitHub release notes for complete


Yes, a brand name. And depends on how much you should respect brand name camel case. In running text, should you write "iPhone" as Apple wants or "Iphone" which better conforms with normal writing? I tend to write "Github" and "Iphone". I think it is easier to read and write.

I find both jarring. But I can easily drop individual corrections (as I've already done), so I'm happy to drop them if that's desirable. I don't want perfection to be the enemy of incremental improvement.

I can see both views, and I do not have such a strong meaning. I'll ask the others in the team. Thanks for your engagement!

matsduf · 2024-06-26T15:27:12Z

A lot of nice corrections. Changing the zone names and name server names for test zones have consequences beyond this repository. The corrections must be done in the develop branch.

jsoref · 2024-06-26T15:37:12Z

I can change branches... probably won't do it until evening...

jsoref · 2024-06-26T15:37:28Z

I could also split those changes out if that's more helpful

jsoref · 2024-06-26T15:43:35Z

I've dropped sibling which was a zone change and have of example. I don't think there are any other things that change server names or zone content, but I was doing a quick skim.

matsduf · 2024-06-26T16:20:37Z

I've dropped sibling which was a zone change and have of example. I don't think there are any other things that change server names or zone content, but I was doing a quick skim.

I saw no zone or name server names left. If they are to be change it should be in a separate PR coordinated with needed changes in Zonemaster-Engine.

matsduf · 2024-07-08T13:43:10Z

I changed target branch to develop. Some updates in connection to the release have created conflicts. Can you handle those in the PR?

jsoref · 2024-07-08T13:48:23Z

@matsduf: done

marc-vanderwal

Well, thanks for this much-needed round of spell-checking!

I’m perfectly fine with this change, but there are a few little mistakes and omissions that need to be addressed before merging this PR.

marc-vanderwal · 2024-07-09T10:04:24Z

+DS10_NAME_NOT_COVERED_BY_NSEC      | ERROR   | ns_ip_list | The nonexistent name is not correctly covered by the NSEC records.
+DS10_NAME_NOT_COVERED_BY_NSEC3     | ERROR   | ns_ip_list | The nonexistent name is not correctly covered by the NSEC3 records.
+DS10_NON_EXISTENT_RESPONSE_ERROR   | ERROR   | ns_ip_list | No or error in response of an expected nonexistent name.


The messages in Zonemaster::Engine are different, but do erroneously spell non-existent as nonexistent.

I can drop, but my preference is to move both repositories to nonexistent. I can also move this to a different PR...

Wikipedia has nonexistent as main entry, but non-existent as an alternative.

https://en.wiktionary.org/wiki/nonexistent#English

https://en.wiktionary.org/wiki/non-existent#English

However, dictionary.com has no entry for “non-existent”; only “nonexistent”. I suggest we go ahead fixing the spelling mistake both here and in the msgid.

I was going to say that there is a discrepancy between the spec and the code in the messages, but the specification of DNSSEC10 merely states “Description of when message tag is outputted”. However, more recent specifications do have an exact copy of the msgids in that column. Shouldn’t we create an issue about that?

I do not think we need to create an issue because we know that we have old specifications that need an update (and @tolvmannen has started with the first in that list, Address01).

@marc-vanderwal, I think it would be wrong to consider "non-existent" to be an error just because dictionary.com is lacking it. My printed New World Dictionary states that "a hyphen may be used after non-". Both alternatives are as correct.

marc-vanderwal · 2024-07-09T10:06:53Z

 [Method5]:                                    ../Methods.md#method-5-obtain-the-name-server-address-records-from-child
 [NOTICE]:                                     ../SeverityLevelDefinitions.md#notice
-[Non-Existent Query Name]:                    #the-non-existent-query-name
+[Non-Existent Query Name]:                    #the-nonexistent-query-name


This change alone will break the link. In order to avoid that, the corresponding section header should also have its spelling fixed (see line 306) and the links in this document need to be updated accordingly.

Thanks. I think I've adjusted this properly.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

marc-vanderwal

Looks good to me!

tgreenx

Thanks for this !

jsoref commented Jun 26, 2024

View reviewed changes

jsoref force-pushed the spelling branch 2 times, most recently from 0e319d9 to 6ce43e4 Compare June 26, 2024 15:42

matsduf changed the base branch from master to develop July 8, 2024 13:41

jsoref force-pushed the spelling branch from 6ce43e4 to 93a40a3 Compare July 8, 2024 13:48

matsduf previously approved these changes Jul 8, 2024

View reviewed changes

matsduf requested review from MichaelTimbert, marc-vanderwal and tgreenx July 8, 2024 13:57

marc-vanderwal reviewed Jul 9, 2024

View reviewed changes

jsoref added 13 commits July 9, 2024 09:21

spelling: a

a9efdd8

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: absolute

f7f140a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: address

31b4609

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: addresses

4d27dc5

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: already

4f29add

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: are

19f88aa

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: associated

981df46

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: at least

c40da91

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: authoritatively

4309962

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: branches

d664862

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-insensitive

52b111a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-sensitive

dc82013

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: committee

a51fbf2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref added 21 commits July 9, 2024 22:55

spelling: requirements

022f8f5

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: responds

a161bbf

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: responses

67dcc4b

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: responsibilities

593431e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: retrieved

0fa8d4e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: searching

406df65

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: specification

7625391

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: specified

35f7c6e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: successful

0ebc0e7

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: successfully

512d56f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: the

d650717

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: those

540613d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: trailing

d1c4756

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: update

06d0693

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: variables

9f22544

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: verified

a850f8e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: verifies

b3530f4

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: versioning

156d017

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: would

0ceee51

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: writing

f070784

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: zonemaster

5c5d45c

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref dismissed matsduf’s stale review via 5c5d45c July 10, 2024 03:03

jsoref force-pushed the spelling branch from 93a40a3 to 5c5d45c Compare July 10, 2024 03:03

marc-vanderwal approved these changes Jul 10, 2024

View reviewed changes

matsduf approved these changes Jul 10, 2024

View reviewed changes

tgreenx approved these changes Aug 20, 2024

View reviewed changes

tgreenx merged commit f2aa460 into zonemaster:develop Aug 20, 2024

tgreenx added this to the v2024.2 milestone Aug 20, 2024

tgreenx added the A-Documentation Area: Documentation only. label Aug 20, 2024

jsoref deleted the spelling branch August 20, 2024 14:59

Uh oh!

Conversation

jsoref commented Jun 26, 2024

Purpose

Context

Changes

How to test this PR

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matsduf commented Jun 26, 2024

Uh oh!

jsoref commented Jun 26, 2024

Uh oh!

jsoref commented Jun 26, 2024

Uh oh!

jsoref commented Jun 26, 2024

Uh oh!

matsduf commented Jun 26, 2024

Uh oh!

matsduf commented Jul 8, 2024

Uh oh!

jsoref commented Jul 8, 2024

Uh oh!

marc-vanderwal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matsduf Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marc-vanderwal left a comment

Choose a reason for hiding this comment

Uh oh!

tgreenx left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

matsduf Jul 9, 2024 •

edited

Loading