DOC WIP: Tutorial: Single structured file

Summary

After #129 (closed). Insert a meaningful description for this merge request here: What is the new/changed behavior? Which bug has been fixed? Are there related issues?

Focus

Point the reviewer to the core of the code change. Where should they start reading? What should they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the specs, finding more corner cases, concrete questions)?

Test Environment

How to set up a test environment for manual testing?

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caoscrawler/converters.py

@@ -389,8 +389,8 @@ class Converter(object, metaclass=ABCMeta):
         Extract information from the structure element and store them as values in the
         general store.
 
-        Parameters:
-        ------------
+        Parameters
+        ----------
 
         values: GeneralStore
             The GeneralStore to store values in.
@@ -409,8 +409,8 @@ class Converter(object, metaclass=ABCMeta):
         Check if transformers are defined using the "transform" keyword.
         Then apply the transformers to the variables defined in GeneralStore "values".
 
-        Parameters:
-        ------------
+        Parameters
+        ----------
 
         values: GeneralStore
             The GeneralStore to store values in.