Feature/sg 1070 Remove description
property -> include it in update
instead + add docstrings
#206
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Main Change
Storing the
title
,description
,notice
andwarnings
inside the output of each feature instead of handling it like an internal state (with properties)Why ?
Other
Why ?
description
property is removed, we cannot use it anymore to generate the documentation. The workaround (and probably cleaner approach anyway) is to generate the description of the feature based on the feature docstringmkdocs
we won't need the documentation script anymore, but then with this PR will already have proper docstrings for each feature so it's still a win