Skip to content

Conversation

d-ronnqvist
Copy link
Contributor

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 API DocumentationNode.Name.symbol but DocC only ever creates symbol 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.

  • Added Updated tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary Not applicable

@d-ronnqvist d-ronnqvist added the code cleanup Code cleanup *without* user facing changes label Jun 18, 2024
@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

Copy link
Contributor

@anferbui anferbui left a 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.

@d-ronnqvist d-ronnqvist added the source breaking DocC's public API isn't source compatible with earlier versions label Jun 18, 2024
@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist
Copy link
Contributor Author

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.

I think @franklinsch is probably the only other person on the team who remembers this type 😄

Copy link
Contributor

@anferbui anferbui left a 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!

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist merged commit f53b6e0 into swiftlang:main Jun 19, 2024
@d-ronnqvist d-ronnqvist deleted the deprecate-code-listing branch June 19, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code cleanup Code cleanup *without* user facing changes source breaking DocC's public API isn't source compatible with earlier versions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants