Skip to content

Remove deprecated path properties #372

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

Merged

Conversation

d-ronnqvist
Copy link
Contributor

Bug/issue #, if applicable: none

Summary

This removes the deprecated path properties on LinkDestinationSummary and LinkDestinationSummary/Variant.

Doing this gets rid of a handful of deprecation warnings that add noise when running the tests.

Dependencies

n/a

Testing

n/a

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

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

Copy link
Contributor

@franklinsch franklinsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Sep 8, 2022

Although this property is marked as deprecated, it's access level is public. Is this OK for us to break the public API in swift-docc from release/5.7 to release/5.8?

Is it acceptable if we do the same thing for swift-markdown and swift-docc-symbolkit when we are release a new Swift+1 version?

@franklinsch

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@franklinsch
Copy link
Contributor

Although this property is marked as deprecated, it's access level is public. Is this OK for us to break the public API in swift-docc from release/5.7 to release/5.8?

Is it acceptable if we do the same thing for swift-markdown and swift-docc-symbolkit when we are release a new Swift+1 version?

@franklinsch

We should be looking at this on a case-by-case basis, but in general we should avoid API breaking changes as much as possible. I don't expect the LinkDestinationSummary API to be commonly used by clients, so the impact here wouldn't be large. However, another approach we could've opted for here is to remove only the call sites of these properties, and keep the deprecated property a little longer.

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist merged commit be0a6bf into swiftlang:main Sep 9, 2022
@d-ronnqvist d-ronnqvist deleted the remove-deperecated-path-property branch October 25, 2024 09:00
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

Successfully merging this pull request may close these issues.

3 participants