add plan for future refarctoring
All checks were successful
CI/CD Pipeline / test (push) Successful in 31s
All checks were successful
CI/CD Pipeline / test (push) Successful in 31s
This commit is contained in:
parent
ffb1347b51
commit
5131b39a65
15
README.md
15
README.md
@ -1,5 +1,20 @@
|
||||
RISolve
|
||||
|
||||
# Features (to be moved to lib.rs one-by-one)
|
||||
- Text to structured law
|
||||
- `LawBuilder`: Structure law, by specifying (sub-)sections (`new_header`), its description (`new_desc`), paragraphs under the current (sub-)section (`new_par`), and the description of the next paragraph (`new_next_para_header`). `Classifier` need to be set.
|
||||
- Main output: Properly structured laws (`Law`)
|
||||
- `Law`: Represents a structured law text. Can be generated with `LawBuilder`.
|
||||
- Main output: properly formatted (md for a start) law text, no need to export Heading/... etc
|
||||
- RIS Fetcher (to be mocked)
|
||||
- all paragraphs of specific law (`overview`)
|
||||
- xml document from url (`par/mod.rs fetch_age`)
|
||||
- Parser
|
||||
- replace errors w/ config file
|
||||
|
||||
# Integration test
|
||||
- Nice test would be to re-create html ris file and compare it (problem with custom fixes, though)
|
||||
|
||||
# History
|
||||
- [I've created my first parser using RIS API, daily updated. Failed because I tried to do too much automatically (e.g. recognizing headers](https://gitlab.com/PhilippHofer/law)
|
||||
- [Using print-website, I've extracted stuff w/ regex.](https://gitlab.com/PhilippHofer/ris/)
|
||||
|
Loading…
Reference in New Issue
Block a user