Skip to content

Conversation

fnesveda
Copy link
Member

@fnesveda fnesveda commented Jun 9, 2021

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 as Enum items, and updates the documentation of those arguments to point to those Enums.

The PR also adds the description of those Enums 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 just consts, so that users can import those Enums from those consts like from apify_client.consts import ActorJobStatus and use the Enum items in the client methods.

@fnesveda fnesveda added enhancement New feature or request. adhoc Ad-hoc unplanned task added during the sprint. debt Code quality improvement or decrease of technical debt. labels Jun 9, 2021
@fnesveda fnesveda added this to the 15th Sprint - Platform team milestone Jun 9, 2021
@fnesveda fnesveda requested review from mhamas, Equidem and drobnikj June 9, 2021 16:06
@fnesveda fnesveda self-assigned this Jun 9, 2021
Copy link
Contributor

@mhamas mhamas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@fnesveda fnesveda force-pushed the feature/unify-quotes branch from 965e30e to abf1e94 Compare August 2, 2021 08:32
Base automatically changed from feature/unify-quotes to master August 2, 2021 08:33
@fnesveda fnesveda force-pushed the feature/correct-use-of-enums branch from 09bed8a to 506e305 Compare August 2, 2021 08:35
@fnesveda fnesveda merged commit 526078c into master Aug 2, 2021
@fnesveda fnesveda deleted the feature/correct-use-of-enums branch August 2, 2021 08:38
@fnesveda fnesveda added the validated Issues that are resolved and their solutions fulfill the acceptance criteria. label May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. debt Code quality improvement or decrease of technical debt. enhancement New feature or request. validated Issues that are resolved and their solutions fulfill the acceptance criteria.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants