Maintenance

README.rst

@@ -18,10 +18,15 @@ Json Preprocessor's Package Description
 Getting Started
 ---------------
 
-The JsonPreprocessor is a python3 package which allows programmers to handle  
-additional features in json files such as comments, imports, overrides, etc. 
-The json files containing comments, imports,... will be handled by the JsonPreprocessor 
-package which returs as result an dictionary object of the deserialized data.
+The JsonPreprocessor is a Python3 package which allows programmers to handle  
+additional features in json files such as
+
+* add comments
+* import other json files
+* overwrite already existing parameters with new values
+
+These json files will be handled by the JsonPreprocessor which returns as result
+a dictionary object of the deserialized data.
 
 How to install
 --------------
@@ -42,7 +47,7 @@ package documentation is located in 'doc/_build/'.
 Package Documentation
 ---------------------
 
-A detailed documentation of the Json Preprocessor's Package can be found here: `Json-Preprocessor.pdf <https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/doc/_build/latex/Json-Preprocessor.pdf>`_
+A detailed documentation of the Json Preprocessor's package can be found here: `Json-Preprocessor.pdf <https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/doc/_build/latex/Json-Preprocessor.pdf>`_
 
 Feedback
 --------

config/CConfig.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 #  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

config/CExtendedSetup.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 #  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

doc/additional_doc/feature_documentation.rst

@@ -20,11 +20,15 @@ Introduction:
 
 .. image:: /images/python3-jsonpreprocessor.png
 
-The JsonPreprocessor is the python3 package which allows programmer to handle some 
-additional features in json file such as comment, import, override, etc for 
-configuring purpose. The json file containing comment, import,... will be handled 
-by JsonPreprocessor package then returned the final dictionary object for python 
-program.
+The JsonPreprocessor is a Python3 package which allows programmers to handle  
+additional features in json files such as
+
+* add comments
+* import other json files
+* overwrite already existing parameters with new values
+
+These json files will be handled by the JsonPreprocessor package which returns as result
+a dictionary object of the deserialized data.
 
 New features
 ~~~~~~~~~~~~
@@ -42,17 +46,14 @@ Features in details
 
 Adding comments to Json file
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The JsonPreprocessor allows adding comments into json file, a comment could be 
-added follow **"//"**.
 
-This is required becuase some big projects require a large json configuration file
-which contains a huge number of configuration parameters for the different features.
-Therefore, having the need of adding comments into json file to clarify the different 
-configuration parameters.
+Every line starting with **"//"**, is commented out. Therefore a comment is valid for singles lines only.
+
+Comment out a block of several lines with only one start and one end comment string, is currently not supported.
 
-**Note:** This package is not allow commented a block of json code, each comment 
-must be added with **"//"**.
+Adding comments to json files is useful in case of more and more content is added, e.g. because of a json file
+has to hold a huge number of configuration parameters for different features. Comments can be used here
+to clarify the meaning of these parameters or the differences between them.
 
 **Example:**
 
@@ -102,13 +103,12 @@ must be added with **"//"**.
 Import the contents from other json files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This import feature allows user merges the content of other json files into the 
-json file, it also allows the nested importing means we can use import feature in 
-the imported files.
+This import feature enables developers to take over the content of other json files into the 
+current json file. A json file that is imported into another json file, can contain imports also
+(allows nested imports).
 
-The import feature helps user distinguish the configuration parameters of each 
-functions, purposes, variants, and so forth into the separate json files. Therefore, 
-we can easy to understand and manage the configuration parameters of big project.
+A possible usecase for nested imports is to handle similar configuration parameters of different variants of a feature
+or a component within a bunch of several smaller files, instead of putting all parameter into only one large json file.
 
 **Example:**
 

setup.py

@@ -11,7 +11,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-# -*- coding: utf-8 -*-
+
 
 # **************************************************************************************************************
 #
@@ -61,7 +61,7 @@
 #
 # 09.02.2022 / XC-CT/ECA3-Queckenstedt
 # Suppressed generation of documents and installations in case of command line
-# parameter is not 'install' and not 'build' (this enables printing the help only).
+# parameter is not 'install' and not 'build' (this enables printing the help only). (10.02.2022: and not 'sdist')
 #
 # 11.10.2021 / XC-CI1/ECA3-Queckenstedt
 # Fixed computation order of readme files together with long_description
@@ -185,9 +185,6 @@ def run(self):
 
     with open("README.md", "r", encoding="utf-8") as fh:
         long_description = fh.read()
-        print(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
-        print(long_description)
-        print("<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<")
 
 # --------------------------------------------------------------------------------------------------------------
 

sphinx-makeall.py

@@ -11,7 +11,6 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-# -*- coding: utf-8 -*-
 
 # **************************************************************************************************************
 #