Skip to content

Conversation

@LecrisUT
Copy link
Collaborator

I have caught an issue with the colon fencing breaking the set, while tick fencing works fine. But the section still feels off because the tabs are too big and specialized, e.g. it is not clear where warning applies or Writing metadata subsection. I think it would flow more clearly if we move it away to a separate document.

@LecrisUT LecrisUT requested a review from henryiii February 20, 2025 11:20
@henryiii
Copy link
Collaborator

Colon fencing has to have a blank line, like this:

Before

:::

Inside

:::

After

Otherwise the formatter messes it up. If you use tick-marks, then it is ignored by the formatter, some spell checkers, etc (because it's supposed to be code).

@LecrisUT
Copy link
Collaborator Author

Colon fencing has to have a blank line, like this:

I tried with various degrees of whitespacing until I was able to confirm that my issue was with the colon fencing in 57fcae1. I.e. if you try to add a new tab on the dev branch in Dynamic metadata after Regex, it splits it into a new group, but not with the tick fencing. Seems like a bug in one of the upstreams.

@henryiii
Copy link
Collaborator

Ahh, the outer blocks need more : than inner blocks. It works correctly if you use :::: for the tabs and ::: for the thing inside (and after), it works correctly.

@henryiii
Copy link
Collaborator

This doesn't affect the reworked docs in this PR, right?

@LecrisUT
Copy link
Collaborator Author

This doesn't affect the reworked docs in this PR, right?

😅 no those are long moved. Well except the versionchanged block, I've copied with the tick fencing from the 1st commit

@henryiii henryiii merged commit 42f82b4 into scikit-build:main Feb 20, 2025
60 checks passed
@LecrisUT LecrisUT deleted the docs/structure branch February 21, 2025 15:35
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