add license information in readme; update tests for new law texts
Some checks failed
CI/CD Pipeline / test (push) Has been cancelled
Some checks failed
CI/CD Pipeline / test (push) Has been cancelled
This commit is contained in:
parent
33b04234cb
commit
201def601f
24
README.md
24
README.md
@ -1,13 +1,11 @@
|
||||
# Add new law text
|
||||
## Tests
|
||||
- Getting paragraphs from `law_id` (`risparser::overview::test::parse()`)
|
||||
- Create file `law_id` in `./data/expected/overview` (then run tests to get current output + save in file)
|
||||
- Create config file in `./data/configs/`
|
||||
# RISP
|
||||
## Add new law text
|
||||
- Tests: Create config file in `./data/configs/` and run the tests (`cargo t`). This will automatically create tests both for `overview` and `par` (by adding new files in `expected/`).
|
||||
|
||||
# Integration test
|
||||
## Integration test
|
||||
- Nice test would be to re-create html ris file and compare it (problem with custom fixes, though)
|
||||
|
||||
# Goals
|
||||
## Goals
|
||||
|
||||
- [x] I want to have the text of the law.
|
||||
- [x] I want to see the structure (proper headers) of the law.
|
||||
@ -15,12 +13,12 @@
|
||||
- [ ] I want to see since when this paragraph is in use.
|
||||
- [.] Lawtext should be updateable
|
||||
|
||||
# Mindset
|
||||
## Mindset
|
||||
|
||||
- I don't want to restrict myself with a [parser combinators](docs.rs/nom) but code it myself using *recursive descent* parser.
|
||||
- Be strict in what I process. Fail if anything unexpected happens. The user should handle this case. It's fine if one decides to ignore the new/unexpected field, but it should be done deliberately.
|
||||
|
||||
# Nomenclature
|
||||
## Nomenclature
|
||||
|
||||
- Law ("Gesetz"): e.g. UHG, TEG, ABGB
|
||||
- Section ("Paragraph")
|
||||
@ -28,8 +26,14 @@
|
||||
- Item ("Ziffer")
|
||||
- Heading-{1,2,3,...}
|
||||
|
||||
# Folder-Structure of this repo
|
||||
## Folder-Structure of this repo
|
||||
- ./data
|
||||
- cache -> cache for `overview` tests
|
||||
- expected
|
||||
- overview -> expected xml links of law_ids
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the EUPL, Version 1.2 or – as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"). You may not use this work except in compliance with the Licence.
|
||||
|
||||
**License**: [European Union Public License v1.2](https://joinup.ec.europa.eu/software/page/eupl)
|
||||
|
Loading…
Reference in New Issue
Block a user