Add DocC extension page to provide curation for TLSConfiguration #532
Conversation
|
Ah... docs-check in soundness (which failed) is running with a Swift 6.0 image, and I used 6.1, which has some slightly different patterns of resolving overloaded methods. I'll apply updates to the DocC content that work with DocC in Swift 6.0 to resolve. |
Motivation: When viewing the documentation, deprecated methods clutter up available options, sometimes below, making those options hard to find for a developer working out how to add or create a TLSConfiguration. Modifications: Adds a DocC extension file (markdown format) the provides curation (organization of the symbols) to order by task and ideally usefulness, with deprecated methods pushed downward. Result: The documentation at https://swiftpackageindex.com/apple/swift-nio-ssl/main/documentation/niossl/tlsconfiguration (and future releases) will include this organization and be easier to read through for developers.
Head branch was pushed to by a user without write access
heckj
force-pushed
the
TLSconfiguration-curation
branch
from
777917f to
acac00a
Compare
|
I ended up stripping out the curation for the overloaded deprecated initializers, as I couldn't land what the relevant hashes were to get Swift 6.0 to reliably agree they were acceptable variants. This still leaves them at the bottom of the document, albeit uncurated. The curation I applied originally is relevant in Swift 6.1, but won't pass checks with the current GH action review, which uses Swift 6.0's version of DocC and its older disambiguation process. |
|
Are you happy to proceed with this in its current form @heckj? |
|
Yes, thank you @Lukasa - mostly wanted to get the soundness checks passing |
2 participants
Motivation:
When viewing the documentation, deprecated methods clutter up available options, sometimes below, making those options hard to find for a developer working out how to add or create a TLSConfiguration.
Modifications:
Adds a DocC extension file (markdown format) the provides curation (organization of the symbols) to order by task and ideally usefulness, with deprecated methods pushed downward.
Result:
The documentation at
https://swiftpackageindex.com/apple/swift-nio-ssl/main/documentation/niossl/tlsconfiguration (and future releases) will include this organization and be easier to read through for developers.