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

Please include new level 1 header in error message when a new level 1 header is added to a markdown document #1792

Open
jayhawk87 opened this issue Jan 3, 2025 · 1 comment
Labels
Backlog bug Something isn't working

Comments

@jayhawk87
Copy link
Contributor

Describe the bug

When validating a markdown document against a markdown template, if the document has additional level 1 headings, the error
output only states that new headers have been added. It is left to the reader to figure out which one has been added.

To Reproduce

Steps to reproduce the behavior:

  1. Establish a markdown template
  2. Create a document from that template
  3. Add a new level one header to the end of the document
  4. Validate the document against the template and see something like the following result:
New headers of level 1 were added to the markdown instance: /mnt/arch-design/ssad/privileged-access-gateway/privileged-access-gateway-ssad.md.
INVALID: arch-design/ssad/privileged-access-gateway/privileged-access-gateway-ssad.md

Expected behavior

Expect to see additional line(s) showing the added headers to make it easy to find in the document.

Screenshots / Logs.

None needed

Environment

  • OS: [e.g. iOS] MacOS
  • Python version: 3.11.11
  • Installed packages: standard trestle install
@jpower432 jpower432 added the bug Something isn't working label Jan 7, 2025
@jpower432 jpower432 moved this from New to Ready in Trestle Roadmap Jan 7, 2025
@jpower432
Copy link
Member

Thanks for the issue @jayhawk87. I was able to reproduce with our community repo templates using the steps you provided.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backlog bug Something isn't working
Projects
Status: Ready
Development

No branches or pull requests

2 participants