Page MenuHome GnuPG

Libgcrypt documentation: corrections to obvious misprints
Open, Needs TriagePublic

Description

I've found some obvious misprints and formatting issues in the Libgcrypt documentation, so I'm submitting a patch (relative to the current master head, Git commit 47e425e07995454573e28c13c08229d2f8a75642) to correct them.


It also includes some minor edits related to the most misleading punctuation and wording (if expressions like “related with” and “aside of” were intentional, I apologize, please disregard these). The edits are mostly limited to a single symbol (or very few words) per line, so it's better to view them in the word-diff mode.

I've are also noticed some issues that require attention but cannot be corrected so obviously and thus not included in the patch:

  1. The section “3.2 Error Handling” has nearly duplicate paragraphs. I guess, the last 3 paragraphs (from “Most functions...” to “...according manual.”) should be deleted, but the very last sentence perhaps should remain.
  1. Descriptions of functions working with handles use somewhat inconsistent naming for the handle argument. Namely, in each section, the very first function calls it “hd” (consistent with the “..._hd_t” types), but all subsequent functions call it just “h”. Is there a reason for such distinctions, or it would be better to rename them all to “hd” (for consistency with the type names) or to “h” (for brevity; not changing the type names, of course)?
  1. Throughout the documentation, there is some mixed usage of the terms “bytes” and “octets”, even though it seems that they are supposed to mean the same thing. Would it be better to change all “octets” to more habitual “bytes”, or all “bytes” to technically more specific “octets”?

And, by the way, some corrections to the web page describing this BTS (https://www.gnupg.org/documentation/bts.html):

Duplicated fragment:

If you want to want to ask
       ^^^^^^^ ^^^^^^^

Probably should be "this":

please indicate the in the Priority field
                ^^^

Missing commas:

and if you are using a non-released version the Git commit id
   ^                                       ^

Missing comma:

If you don't know the version leave it blank
                             ^

Event Timeline

MikhailRyazanov renamed this task from Corrections to obvious documentation misprints to Corrections to obvious Libgcrypt documentation misprints.Sep 12 2021, 11:49 PM
MikhailRyazanov added a project: libgcrypt.
MikhailRyazanov updated the task description. (Show Details)
MikhailRyazanov renamed this task from Corrections to obvious Libgcrypt documentation misprints to Libgcrypt documentation: corrections to obvious misprints.Sep 12 2021, 11:51 PM