Point the notice at the licence it promises - #159
Merged
Conversation
NOTICE.md tells a reader that "the license contains the full warranty and liability disclaimer" and named no file. The licence is at the root now, so the sentence carries a link a reader can follow instead of a noun with nothing behind it. The failure this prevents is the first one a reader meets. A document that promises a second document and does not say where it is sends the reader to look for it, and on this repository the warranty and liability disclaimer is the thing they were sent to find. Refs #12 Signed-off-by: Nils Lehnen <30603423+iderex@users.noreply.github.com>
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
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.
The issue this belongs to
Closes #12
What changed
NOTICE.mdtells a reader that the license contains the full warranty andliability disclaimer. It named no file, and until recently there was no file to
name. There is one now, so the sentence links to it.
What failure it prevents
A reader who wants to know what warranty they are getting reads
NOTICE.md, istold the answer is in the license, and is then left to find it. The disclaimer
is the thing they were sent to look for, and the distance between the promise
and the document was one link.
Evidence
The licence is at the root and GitHub reads it:
The sections
NOTICE.mdsends a reader to are in it:README.mdnames the licence under its second heading, which a reader reacheswithout scrolling:
The new link is a path this tree's own checker reads, and it resolves. The count
moves by exactly one, which is what says the link joined the population rather
than sitting beside it. With
origin/main'sNOTICE.mdin the working tree:and with this branch's:
The unicode guard's scan, run the way the workflow runs it:
which is the clean exit rather than a match found.
The sign-off comparison the DCO workflow makes, run against the commit being
pushed:
What a guard here refuses, and the proof it bites
This change adds no guard. The counts above are an existing check reading one
more path, not a new refusal.
What this does not cover
Entry 1 of #1 carries no written answer, and the five options it lists do not
include AGPL-3.0. What the tree carries is the licence #157 argued for and
landed. The condition #1 sets for itself, that each entry has an answer written
into it, is untouched here.
Nothing reads whether the sentence in
NOTICE.mdis true of the file it nownames. The path check reads that the target resolves and stops there. Whether
sections 15 to 17 are what a reader was promised is read by a person.
Two of the four conditions on #12, the licence field and the sentence in
README.md, were already met before this change rather than by it. I checkedthem and did not produce them.
Who has read it
Nobody other than me has read this change. The commands above stand in place of
a review rather than beside one.