Swift DocC Plugin Pitch: Add symbolGraphMinimumAccessLevel option support

I propose to add a new symbolGraphMinimumAccessLevel option support. (Implemented as --experimental-symbol-graph-minimum-access-level in the PR now)

The current behavior for it is for library target we assume it to be public and for executable target we assume it to be internal implemented in defaultSymbolGraphOptions.

I propose to add symbol-graph-minimum-access-level option in command line so that we can opt-out the default internal behavior for executable target.

The use case is that for some package, we want to documentation the executable target via docc bundle but we do not want to expose the internal symbol graph into the documentation.

PR: Add symbolGraphMinimumAccessLevel option support by Kyle-Ye · Pull Request #82 · apple/swift-docc-plugin · GitHub

Related discussion: cc @Joseph_Heck

5 Likes

A huge +1 from me!

In the PR, you have the CLI optional as including 'experimental' - and I'd prefer to just see it directly matching the DocC CLI option, rather than tacking on the experimental addition. It feels superflous because this is (now) a well established option in DocC and matches the "upstream" functionality one to one.

In the PR, you have the CLI optional as including 'experimental' - and I'd prefer to just see it directly matching the DocC CLI option, rather than tacking on the experimental addition

Replied on the PR. It's a start-up PR suggestion from the package maintainer. We'll get ride of it eventually.

Update: The feature is landed onto main branch of swift-docc-plugin without experimental prefix.

2 Likes