derivepassphrase.git

Copyedit the wishlist entry specification for errors
Parent 0d39dfb
Marco Ricci

Marco Ricci commited on 2026-08-30 20:00:55
Zeige 1 geänderte Dateien mit 4 Einfügungen und 4 Löschungen. 

We add more references to PuTTY where sensible, and generalize
references to derivepassphrase.  We also fix the linking of the
"distinguishing between bugs and wishes" footnote.
spec.md
Zeige Datei @ 7d58f51
... ... 
@@ -24,7 +24,7 @@ Class
24 24 
     | `bug`  | This is clearly an actual problem we want fixed. |
25 25 
     | `wish` | This is a request for an enhancement.            |
26 26
27 
-    (We do not differentiate `semi-bug`, `vulnerability` and `bug` at the class level.)
27 
+    (Unlike PuTTY, we do not further differentiate between `semi-bug`, `vulnerability` and `bug` at the class level.)
28 28
29 29 
 Priority
30 30 
 :   How urgent is this entry?
... ... 
@@ -77,8 +77,8 @@ Blocks:
77 77
78 78 
     (Not documented in PuTTY's wishlist entry specification, but in use across that wishlist.)
79 79
80 
-[^distinguishing-bugs-and-wishes]:
81 
-    A bug is specifically an entry describing an aspect of `derivepassphrase` that, if not fixed, impedes or prohibits the user from accomplishing their goal within `derivepassphrase`.
80 
+[^distinguishing-between-bugs-and-wishes]:
81 
+    A bug is specifically an entry describing an aspect of this software that, if not fixed, impedes or prohibits the user from accomplishing their goal with or within this software.
82 82 
     Every other entry is a wish.
83 83
84 84 
 ## The summary
... ... 
@@ -89,4 +89,4 @@ In particular, the summary *should not* be a chronological listing of events or
89 89
90 90 
 Specific to this system, the summary always contains a paragraph beginning with <b>Therefore</b> that describes the action to take for this entry.
91 91 
 If applicable, a sentence beginning with <b>Until then</b> within that paragraph contains workarounds or partial solutions that will be applied or have already been applied.
92 
-Except for optional historical context that may follow this paragraph and may be interactively hidden, the <b>Therefore</b> paragraph is the *last* paragraph of the summary.
92 
+Except for optional historical context that may follow this paragraph and is then hidden by default, the <b>Therefore</b> paragraph is the *last* paragraph of the summary.
93 93