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

Patch up autodoc code blocks #2180

Merged
merged 4 commits into from
Nov 26, 2024
Merged

Conversation

alerque
Copy link
Member

@alerque alerque commented Nov 25, 2024

Closes #2168

@alerque alerque added this to the v0.15.7 milestone Nov 25, 2024
@alerque alerque added the documentation Documentation bug or improvement issue label Nov 25, 2024
-- a \raw environment. For this purpose we don't care about and don't want to bother with
-- making sure the leading and trailing whitespace is minimized in the SIL source, so
-- we trim it off here.
content = SU.ast.trimSubContent(content)
Copy link
Member Author

Choose a reason for hiding this comment

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

Does this change sound right to you @Omikhleia? The whitespace being passed in the \raw blocks now being (legitimately) treated as actual lines seems to be the main problem that blew up the manual. My previous fix was obviously wrong, this seems right now. I did tweak the alignment of the rule just a little bit and used raise instead of manually pushing VGlue because sorting out when to add spacing or not was much easier that way. Hence the final test expectations did change just a small shim. I also did not place \novbreak before and after the cod blocks as that seems to introduce yet another problem we'd have to cancel out.

Copy link
Member

Choose a reason for hiding this comment

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

As far as I can say viewing the code (not tested yet), it seems ok.
What is the problem your are having with novbreak, if I may ask? I've some regression (it seems) on them too, though I've not been able yet to track its origin. (Something changed in paragraphing, possibly unrelated however.)

Copy link
Member Author

Choose a reason for hiding this comment

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

Inside the verbatim (or autodoc:codeblock which does the same thing with line handling, if you do not explicitly leave hmode before adding the novbreaks then it flips you over to vmode itself and you end up with a double break. I didn't work on an MWE.

@alerque alerque requested a review from Omikhleia November 25, 2024 20:33
@alerque alerque merged commit a513fee into sile-typesetter:master Nov 26, 2024
21 checks passed
@alerque alerque deleted the verbpar branch November 26, 2024 11:02
@alerque alerque self-assigned this Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or improvement issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix the \autodoc:codeblock I botched during the last release
2 participants