docs: Added new getting started page #232
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
…ge concepts and features pages
* master: chore: update dev deps (#227) chore: update dev deps and gh actions pipelines (#226) chore: Add Python Client examples [docs] (#191) Configure Renovate (#76) chore: bump version to 1.7.1 (#193) fix: aborting of last Actor/task run (#192) chore: Automatic docs theme update [skip ci] # Conflicts: # website/sidebars.js
vdusek
requested changes
May 29, 2024
There was a problem hiding this comment.
Nice, thanks!
I have a few code style suggestions to share.
On top of that, one more thing... It's not a requirement, more a personal preference. In many places I'd prefer not to chain so many calls into one command. Breaking it down to more separate commands can make it more understandable for users. Also when you want to transform such long-chained command into async command, you will end up with multiple awaits in one command. Which is not goood.
For example, instead of writing:
from apify_client import ApifyClient
apify_client = ApifyClient('MY-APIFY-TOKEN')
# Lists items from the Actor's dataset
dataset_items = apify_client.dataset('daset-id').list_items().itemsI'd rather use something like:
from apify_client import ApifyClient
apify_client = ApifyClient('MY-APIFY-TOKEN')
# Get a dataset client
dataset_client = apify_client.dataset('daset-id')
# Lists items from the Actor's dataset
dataset_items = dataset_client.list_items().items
Co-authored-by: Vlada Dusek <v.dusek96@gmail.com>
github-actions
bot
added
the
t-web
|
@vdusek Thanks Vláďo for the suggested improvements! I added a couple of simplifications for the code examples (removed unnecessary chaining). Please let me know if it's ok now |
* master: chore: fix pytest deps (no module named pkg_resources) (#233)
vdusek
approved these changes
May 30, 2024
HonzaTuron
approved these changes
May 30, 2024
Co-authored-by: Vlada Dusek <v.dusek96@gmail.com>
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.
I tried to do the same thing as we did for the JS client here but for Python.
The goal is to improve onboarding (adaptation) for using our API (in Python in this case)