-
Notifications
You must be signed in to change notification settings - Fork 158
Deprecate the unused AttributedCodeListing type #956
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
Deprecate the unused AttributedCodeListing type #956
Conversation
@swift-ci please test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too familiar with the nuances of the type that is being deprecated so I'm not comfortable approving, but the code does look correct to me.
Co-authored-by: Andrea Fernandez Buitrago <[email protected]>
@swift-ci please test |
I think @franklinsch is probably the only other person on the team who remembers this type 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, looks good to me!
@swift-ci please test |
Bug/issue #, if applicable:
Summary
This removes the AttributedCodeListing type that isn't used for anything. There's no way for developers to pass this form of code listings to DocC (unless they use some other tool that imports the SwiftDocC module).
AttributedCodeListing.Line
appears in public APIDocumentationNode.Name.symbol
but DocC only ever createssymbol
name values with a single plain text token.Note, AttributedCodeListing is a feature that was superseded by Snippets and has never been available via the
docc
command line tool.Dependencies
None.
Testing
This is a non-functional change. Everything should continue to behave as before. There's nothing in particular to test.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
AddedUpdated tests./bin/test
script and it succeededUpdated documentation if necessaryNot applicable