Do we have a better name than “Documentation Extensions”?

taylorswift · 2022-09-13T16:46:03.114Z

as i write code that implements documentation extensions, i can’t help but keep getting reminded just how terrible a name “documentation extension” is. extension has a specific meaning in swift, and well, everything we do here in the documentation tooling world is “documentation“-related. and DocumentationExtensionImplementationThing is quite a gnarly name for a type.

do we have a better term for this concept?

jack · 2022-09-13T18:40:49.446Z

A documentation extension extends the documentation for a symbol—it's meant to mirror Swift language feature name because it operates similarly. Are there other words besides 'extension' that describe the behavior more clearly?

taylorswift · 2022-09-13T18:47:45.520Z

jack:

A documentation extension extends the documentation for a symbol—it's meant to mirror Swift language feature name because it operates similarly.

well, we now have:

Dealing with Nested Types when Documenting Extensions with DocC - #6 by theMomax
Document Extensions to External Types Using DocC - #41 by theMomax

which is becoming very confusing when transferring these concepts over into a codebase.

jack:

Are there other words besides 'extension' that describe the behavior more clearly?

i don’t know, but this was the reason for this thread, to brainstorm alternative terminology we can use for this idea