Skip to content

[AX] <table> should be taken out of <figure> and the <figcaption> should become the table’s <caption> #40

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
merged 9 commits into from
May 29, 2023

Conversation

marinaaisa
Copy link
Member

@marinaaisa marinaaisa commented Jan 3, 2022

Bug/issue #30234820, if applicable:

Summary

Tables were contained within a <figure> element. However, there is no need for this and it was making the tables much less accessible. Tables should stand on their own with the previous <figcaption> as the table’s <caption>.

Dependencies

NA

Testing

Use the provided fixture folder:
manual-fixtures.zip

Steps:

  1. Run VUE_APP_DEV_SERVER_PROXY=/path/to/manual-fixtures/ npm run serve
  2. Go to http://localhost:8080/documentation/framework/sloth
  3. Assert that tables' markup is as described in the Summary.

Checklist

  • Added tests
  • Ran npm test, and it succeeded
  • Updated documentation if necessary

@marinaaisa
Copy link
Member Author

@swift-ci please test

Copy link
Contributor

@dobromir-hristov dobromir-hristov left a comment

Choose a reason for hiding this comment

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

Gave it a quick test. Looks the same hehe. Good job.

@marinaaisa
Copy link
Member Author

@swift-ci please test

@marinaaisa
Copy link
Member Author

@swift-ci test

Copy link
Contributor

@dobromir-hristov dobromir-hristov left a comment

Choose a reason for hiding this comment

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

This works alright from what I could test. Left a small comment.

@@ -53,4 +58,8 @@ export default {
/deep/ p {
display: inline-block;
}

caption {
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess this is less of a concern, but if caption-side: bottom; is applied, this styling will not work as expected. However I am not sure how to check that with pure CSS. MDN jus suggest using padding around the caption...

Copy link
Member Author

Choose a reason for hiding this comment

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

After investigating it, I also didn't find a way of checking if caption is on top or bottom so I applied a generic margin: 0fe3af6

@marinaaisa
Copy link
Member Author

@swift-ci test

@marinaaisa marinaaisa merged commit 81138c8 into swiftlang:main May 29, 2023
@marinaaisa marinaaisa deleted the tables-caption branch May 29, 2023 14:45
mportiz08 added a commit to mportiz08/swift-docc-render that referenced this pull request Jun 2, 2023
…ion> should become the table’s <caption> (swiftlang#40)"

This reverts commit 81138c8.
@mportiz08 mportiz08 mentioned this pull request Jun 2, 2023
mportiz08 added a commit that referenced this pull request Jun 2, 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