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

Various docs changes #1813

Merged
merged 6 commits into from
Jun 1, 2023
Merged

Various docs changes #1813

merged 6 commits into from
Jun 1, 2023

Conversation

Omikhleia
Copy link
Member

@Omikhleia Omikhleia commented May 27, 2023

Proposed changes:

  • Add \autodoc:class for styling class names (similar to \autodoc:package)
    • Use it where appropriate
    • Also fix a few missing or erroneous package names
  • Enable autodoc color highlighting1
  • Expand description of horizontal and vertical spacing = Closes Document and add examples for vertical alignment #577
  • Slightly rephrase the explanations on \par vs. leaveHmode() = Closes line spacing issue #868
    Here I mostly removed a weird sentence, slightly changed the formulation and split the dense explanation into shorter paragraphs. Most of the important things were already stated, IMHO, so perhaps harder to find and read.

Footnotes

  1. That may place us in situations where Color at page break affects folios and other frames #1659 occurs, but everything comes at a cost, heh...

@Omikhleia Omikhleia requested a review from alerque as a code owner May 27, 2023 18:02
@Omikhleia Omikhleia self-assigned this May 27, 2023
@Omikhleia Omikhleia requested a review from simoncozens as a code owner May 27, 2023 18:02
@Omikhleia Omikhleia marked this pull request as draft May 27, 2023 18:02
@Omikhleia Omikhleia added the documentation Documentation bug or improvement issue label May 27, 2023
@Omikhleia Omikhleia added this to the v0.14.10 milestone May 27, 2023
@Omikhleia Omikhleia marked this pull request as ready for review May 28, 2023 15:46
@alerque alerque merged commit 504f8b3 into sile-typesetter:master Jun 1, 2023
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.

line spacing issue Document and add examples for vertical alignment
2 participants