Merge pull request #568 from OpenEnergyPlatform/feature-567-add-descr…

…iption-of-cleaning-process

Explain cleansing process #567

CHANGELOG.md

@@ -10,6 +10,8 @@ and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/
 ### Added
 - Add `deleted_market_actors` to data model and prevent crash on unknown tables
   [#575](https://github.com/OpenEnergyPlatform/open-MaStR/pull/575)
+- Extended documentation of data cleansing process for bulk download
+  [#568](https://github.com/OpenEnergyPlatform/open-MaStR/pull/568)
 - Add OFFIS eV as partner organization
   [#493](https://github.com/OpenEnergyPlatform/open-MaStR/pull/493)
 ### Changed

open_mastr/mastr.py

@@ -164,8 +164,10 @@ def download(
 
             Default to `None`.
         bulk_cleansing : bool, optional
-            If True, data cleansing is applied after the download (which is recommended). Default
-            to True.
+            If set to True, data cleansing is applied after the download (which is recommended).
+            In its original format, many entries in the MaStR are encoded with IDs. Columns like
+            `state` or `fueltype` do not contain entries such as "Hessen" or "Braunkohle", but instead
+            only contain IDs. Cleansing replaces these IDs with their corresponding original entries.
         api_processes : int or None or "max", optional
             Number of parallel processes used to download additional data.
             Defaults to `None`. If set to "max", the maximum number of possible processes