jazzy
jazzy copied to clipboard
Drop raw values from declarations
This may be controversial, but I think raw values of enums are designed to be internal: we use the enum to have the abstraction after all.
So instead of
case myEnumCase = "my-enum-case-for-REST"
I'd like to see only the case name (unless the minimum access level is set to internal
or lower).
That does make sense to me. I noticed though that Xcode quick help does display the raw values -- I think jazzy normally tries to follow that lead.
I'm fine with "show as much as possible" for internal developer doc. But shipping a closed-source product causes different needs. While I don't imagine I can really hide stuff from clients, showing them as little as possible in the doc should help preventing them from developing against internals.
I've returned to this from time to time over the years: now it seems like Apple/DocC agrees: the raw value is nowhere to be found in the raw symbolgraph and is omitted from Quick Help etc etc. So I guess we should keep this one!