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

Remove deprecated usages of 'layout' API of 'ContentAndMedia' in docs #531

Merged
merged 3 commits into from
Apr 19, 2023

Conversation

Saafo
Copy link
Contributor

@Saafo Saafo commented Apr 5, 2023

Bug/issue #, if applicable: None.

Summary

Provide a description of what your PR addresses, explaining the expected user experience.
Also, provide an overview of your implementation.

Since 'layout' init parameter of 'ContentAndMedia' is deprecated by https://github.com/apple/swift-docc/blob/f7cc54ab64eeebe06d4ca721cc7ac78c2da6f545/Sources/SwiftDocC/Semantics/ContentAndMedia.swift#L86

We should remove the usages of this parameter in our documents and tests

Dependencies

Describe any dependencies this PR might have, such as an associated branch in another repository.

None.

Testing

Describe how a reviewer can test the functionality of your PR. Provide test content to test with if
applicable.

Steps:

  1. Provide setup instructions.
  2. Explain in detail how the functionality can be tested.

None.

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

@Saafo Saafo marked this pull request as ready for review April 5, 2023 10:13
@Saafo
Copy link
Contributor Author

Saafo commented Apr 7, 2023

@swift-ci please test

@Saafo
Copy link
Contributor Author

Saafo commented Apr 14, 2023

Can someone help me? This PR is ready to merge, should I mention some member to review?

@ethan-kusters ethan-kusters self-requested a review April 18, 2023 18:48
@@ -49,7 +49,7 @@ class ExternalLinkableTests: XCTestCase {
}

@Section(title: "Create a New AR Project 💻") {
@ContentAndMedia(layout: vertical) {
@ContentAndMedia {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we leave this test unchanged for now? Otherwise this PR looks good to go. Thank you!

Suggested change
@ContentAndMedia {
@ContentAndMedia(layout: vertical) {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's ok, I've discard it. But I'm not sure why shouldn't we chsnge it now

@ethan-kusters
Copy link
Contributor

@swift-ci please test

@ethan-kusters
Copy link
Contributor

@swift-ci please test

@ethan-kusters
Copy link
Contributor

Thank you @Saafo! I'll go ahead and merge this now.

@ethan-kusters ethan-kusters merged commit 1d300e7 into swiftlang:main Apr 19, 2023
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.

2 participants