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

🚀 [Feature] Add tests to detect and visualize changes in markdown converter #39

Open
darkdragon-001 opened this issue Apr 17, 2021 · 4 comments
Labels

Comments

@darkdragon-001
Copy link
Collaborator

🚀 Feature

We should add tests for xml to markdown conversion. This way, every code changes producing a different conversion needs to modify the tests, too. This way, a reviewer can easily see the visual changes a certain pull request introduces.

@darkdragon-001
Copy link
Collaborator Author

darkdragon-001 commented Apr 17, 2021

We should create a list of features together with good example laws.

Suggestion:

  • aappo: multi-level headlines, tables, quotes, appendix
  • stvo: images

@ulfgebhardt
Copy link
Member

ulfgebhardt commented Apr 18, 2021

What you can do is:

  1. Copy 5 good examples of a law
  2. Provide it as input for the 2markdown Converter
  3. save the expected markdown output
  4. On test compare those two

@darkdragon-001
Copy link
Collaborator Author

@ulfgebhardt That's the idea. I added my suggestions in #39 (comment). Any additional suggestions for those good examples of law?

@ulfgebhardt
Copy link
Member

Nah I do not have a big knowledge on the data output of this repo. So having such a system in place with your examples is sufficient to have more examples going. Just remember to make it as generic as you can:
Have a folder with rawdata containing law1.rawdata - have a folder with md output data. Expect a file law1.md so its sufficient to just drop those two files in the corresponding folders.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants