Skip to content
Snippets Groups Projects
Commit 4c901109 authored by florian's avatar florian
Browse files

DOC: Update changelog after release

parent edc02d2e
No related branches found
No related tags found
2 merge requests!108Release 0.5.0,!104Create a new scanner module and move functions from crawl module there
......@@ -11,8 +11,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed ###
- Refactoring of the crawl.py module: Now there is a separate scanner module handling the
collecting of information that is independent of CaosDB itself.
- The signature of the function ``save_debug_data`` was changed to explicitely
take the ``debug_tree`` as its first argument. This change was necessary, as
the ``debug_tree`` is no longer saved as member field of the Crawler class.
### Deprecated ###
- The functions ``load_definition``, ``initialize_converters`` and
``load_converters`` are deprecated. Please use the functions
``load_definition``, ``initialize_converters`` and
``create_converter_registry`` from the scanner module instead.
- The function ``start_crawling`` is deprecated. The function
``scan_structure_elements`` in the scanner module mostly covers its
functionality.
### Removed ###
### Fixed ###
......@@ -43,21 +58,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- JSONFileConverter, YAMLFileConverter and MarkdownFileConverter now inherit from
SimpleFileConverter. Behavior is unchanged, except that the MarkdownFileConverter now raises a
ConverterValidationError when the YAML header cannot be read instead of silently not matching.
- Refactoring of the crawl.py module: Now there is a separate scanner module handling the
collecting of information that is independent of CaosDB itself.
- The signature of the function ``save_debug_data`` was changed to explicitely take the debug_tree
as its first argument. This change was necessary, as the debug_tree is no longer saved as
member field of the Crawler class.
### Deprecated ###
- The ``prefix`` argument of `crawler_main` is deprecated. Use the new argument
``remove_prefix`` instead.
- The functions ``load_definition``, ``initialize_converters`` and ``load_converters`` are deprecated. Please use
the functions ``load_definition``, ``initialize_converters`` and ``create_converter_registry`` from the scanner module
instead.
- The function ``start_crawling`` is deprecated. The function ``scan_structure_elements`` in the
scanner module mostly covers its functionality.
### Removed ###
- The command line argument ``--prefix``. Use the new argument ``--remove-prefix`` instead.
......@@ -74,7 +79,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added ###
- Identifiable class to represent the information used to identify Records.
- Added some StructureElements: BooleanElement, FloatElement, IntegerElement,
- Added some StructureElements: BooleanElement, FloatElement, IntegerElement,
ListElement, DictElement
- String representation for Identifiables
- [#43](https://gitlab.com/caosdb/caosdb-crawler/-/issues/43) the crawler
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment