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

Known shortcomings with diff-documents #166

Open
1 of 8 tasks
chrisfenner opened this issue Sep 10, 2024 · 1 comment
Open
1 of 8 tasks

Known shortcomings with diff-documents #166

chrisfenner opened this issue Sep 10, 2024 · 1 comment

Comments

@chrisfenner
Copy link
Member

chrisfenner commented Sep 10, 2024

Open

  • Deleting a whole row from a table is a bit ugly (but adding one is fine)

image

  • Edited equations don't get highlighted

image

  • Warning spew in latex when there are changes to equations
LaTeX Warning: Command \pdfstringdef invalid in math mode on input line 2323.
  • Code diffs indent a little weird

image

  • Diffing algorithm inserts a few empty diffs in certain places

image

  • Diff sometimes takes a LONG time. Consider splitting out diff generation job so that the main doc gets uploaded sooner?

Example: Part1 took 15 minutes in https://github.com/TrustedComputingGroup/TPM-Spec/actions/runs/10816111225

  • Strange numbering for deleted section headings

image

Resolved

  • Mermaid diagrams are always counted as changed because the temp filename changes

image

@chrisfenner
Copy link
Member Author

Mermaid issue was resolved in #178

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

No branches or pull requests

1 participant