Renamed meta to metadata and other cleanups #90
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
olehermanse
commented
Feb 28, 2024
olehermanse
commented
- Python promise modules: Renamed meta parameter to metadata
- Cleaned up README files relating to the updated promise types
- iptables.py: Autoformatting by black
- Bumped version numbers of to be released modules inside python source code
This already confused Ole Petter and myself, so let's use another word that is not identical to 2 existing concepts in CFEngine. (`meta` the promise type and `meta` the promise attribute). Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
|
|
||
| If you'd like to develop new promise types (or other modules) for CFEngine, we recommend finishing our getting started tutorial: | ||
|
|
||
| https://docs.cfengine.com/docs/3.21/getting-started.html |
There was a problem hiding this comment.
Suggested change
| https://docs.cfengine.com/docs/3.21/getting-started.html | |
| https://docs.cfengine.com/latest/getting-started.html |
Maybe link to latest, lts or docs/master ?
There was a problem hiding this comment.
Maybe, I did this on purpose to maybe avoid breaking links in the future.
There was a problem hiding this comment.
yeah i always struggle to decide.
|
|
||
| For more detailed information about how custom promise types work, see our documentation: | ||
|
|
||
| https://docs.cfengine.com/docs/3.21/reference-promise-types-custom.html |
There was a problem hiding this comment.
Same here, maybe link to a not specific version
nickanderson
requested changes
Feb 28, 2024
Removed version numbers from inside READMEs, since nobody has been updating them. Version numbers are already in the index and also in the python file for each module. Removed other unnecessary / duplicated information which just makes the module pages on build.cfengine.com look slightly worse. Tried making things a bit more consistent and easy to read / understand. Added a bit more information and links for the python promise type library. Tixed some small typos. Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
… code Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
nickanderson
approved these changes
Feb 28, 2024
|
|
||
| If you'd like to develop new promise types (or other modules) for CFEngine, we recommend finishing our getting started tutorial: | ||
|
|
||
| https://docs.cfengine.com/docs/3.21/getting-started.html |
There was a problem hiding this comment.
yeah i always struggle to decide.
larsewi
reviewed
Feb 29, 2024
| @@ -182,7 +182,7 @@ def validate_promise(self, promiser: str, attributes: dict, meta: dict): | |||
| if command != "flush" and attributes.get("chain") == "ALL": | |||
| raise ValidationError("Chain 'ALL' is only available for command 'flush'") | |||
|
|
|||
| def evaluate_promise(self, promiser: str, attributes: dict, meta: dict): | |||
| def evaluate_promise(self, promiser: str, attributes: Dict, metadata: Dict): | |||
There was a problem hiding this comment.
What is the reason for using typing.Dict instead of dict?
There was a problem hiding this comment.
I didn't mean anything special by it, I just copy-pasted the function signature from one of the other ones (git promise type I think).
It could make sense to always use the typing ones, make everything look consistent, and they have some more expressive ones. But I don't really have a strong opinion.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.