Enforce use of Enum items in method arguments #47
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.
In some methods in the resource clients, we had the type of some arguments set to some
Enum
, but we actually worked with the arguments as if they were strings. This PR corrects it so that we're actually working with those arguments asEnum
items, and updates the documentation of those arguments to point to thoseEnum
s.The PR also adds the description of those
Enum
s to the documentation, which required a small rework of how the formatting of the documentation works, adding to the mess that that is.I've also renamed the
_consts
submodule to justconsts
, so that users can import thoseEnum
s from those consts likefrom apify_client.consts import ActorJobStatus
and use theEnum
items in the client methods.