documentation updates#296
Conversation
heckj
commented
Apr 27, 2026
heckj
commented
- Fix stale DocC disambiguation hash for PrivateKey init
- Fix documentation errors, typos, and a bug in CertificateStore.appending
- code example fixes within the existing articles:
- Lots of smaller fixes across the board - some copy/pasta errors, consistency in usage, typos and grammar issues - added documentation comments where missing to get all public types covered - applied internal style guidelines for representing the types
The P256 PrivateKey initializer hash changed from 6xkmz to 2we15.
- Fix copy-paste errors in doc comments (NameConstraints, Error.swift, CSRAttribute, ExtendedKeyUsage) - Fix incorrect type names in code examples (SubjectAlternativeNames) - Add missing `try` keyword in code example - Make KeyUsage arguments consistent between snippet and full example - Fix bug where CertificateStore.appending(_:) returned self instead of copy - Fix typos: satifies, currency subnet, the the, PCKS#9 - Fix British spellings: realise, behaviour, fulfil, canonicalisation, organised, modelled - Fix grammar: subject-verb agreement, missing articles, broken sentences, triple backticks, run-on sentences - Fix "the subject is being issued" -> "the certificate is being issued"
- SubjectAlternativeName (singular) corrected to SubjectAlternativeNames (plural) - Missing try on DistinguishedName builder call - Made KeyUsage arguments consistent - Article didn't provide any detail avout CSR, but mentioned it - so now links to CertificateSigningRequest - Added content that explains the derEncodedPrivateKey variable
- some copy/pasta errors, consistency in usage, typos and grammar issues - added documentation comments where missing to get all public types covered - applied internal style guidelines for representing the types
heckj
added
semver/none
dnadoba
left a comment
dnadoba
left a comment
There was a problem hiding this comment.
A simple test for that would be great as well but I wouldn't say required.
Looked briefly over the rest and it looks okay but I will leave that up to the new maintainers.
Co-authored-by: David Nadoba <dnadoba@gmail.com>
dnadoba
added
🔨 semver/patch
|
In the method that I found an issue in, I can just fix the bug, or I can use "consuming" either public or internal as @dnadoba suggested, but that changes the API surface and would seem to warrant a semver/patch or major change - depending on what this project would prefer. I'm happy to go in which-ever direction is desired. I meant to only cover documentation updates and stumbled across the issue when checking for consistency issues. |
|
For copyable types, like in this case, this isn't API breaking. I wouldn't even consider it an API change as this should really just be a calling convention/optimization difference. |
|
The API breakage check is the switching up to using |
josephnoir
left a comment
josephnoir
left a comment
There was a problem hiding this comment.
I like it. Thanks! I got a nit and I stumbled over the singular of "delimiters". I'll let you be the judge though.
Co-authored-by: Raphael <josephnoir@users.noreply.github.com>
4 participants
