Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extensions pick up documentation from other elements #65

Closed
pcantrell opened this issue Sep 14, 2015 · 0 comments
Closed

Extensions pick up documentation from other elements #65

pcantrell opened this issue Sep 14, 2015 · 0 comments

Comments

@pcantrell
Copy link

SourceKitten pulls documentation from other elements for extensions. Here's an example where SourceKitten ignores an extension’s doc comment and instead copies the extended class’s doc comment.

That example is innocuous enough, almost reasonable, but I noticed this problem in a more complex project where a public extension was pulling a :nodoc: from who knows where. Both the extension and the class it extended were public, but Jazzy ignored the extension because of this spurious SourceKitten behavior. (The extension that got the mystery :nodoc: is here. I worked around it locally with a cludge in jazzy to ignore nodoc whenever it appears on an extension.)

jpsim added a commit that referenced this issue Nov 24, 2015
SteffenL pushed a commit to SteffenL/SourceKitten that referenced this issue Feb 13, 2019
- no more <<error type>> or default
- closes jpsim#65 and jpsim#112
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant