Skip to content

Code sample on home page does not work #912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
gdvallance opened this issue Jan 15, 2025 · 1 comment · Fixed by #913
Closed

Code sample on home page does not work #912

gdvallance opened this issue Jan 15, 2025 · 1 comment · Fixed by #913
Assignees
@vdusek
Labels
bug Something isn't working. documentation Improvements or additions to documentation. t-tooling Issues with this label are in the ownership of the tooling team.
Milestone
106th sprint - To...

Comments

@gdvallance
Copy link

The documentation on https://crawlee.dev/python/, is incorrect, specifically, the code in "Now we are ready to execute our first Crawlee project:"

This is on a fresh install as of today (v0.5.1): via: pip install crawlee[all] && playwright install as per https://crawlee.dev/python/docs/introduction/setting-up

The error is here:

from crawlee.playwright_crawler import PlaywrightCrawler, PlaywrightCrawlingContext

The import doesn't resolve.

Correct (taken from other documention) https://crawlee.dev/python/docs/quick-start is:

from crawlee.crawlers import PlaywrightCrawler, PlaywrightCrawlingContext
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 15, 2025
@vdusek
Copy link
Collaborator

vdusek commented Jan 16, 2025

Hi @gdvallance, thank you for reporting this! I will fix it ASAP.

@vdusek vdusek self-assigned this Jan 16, 2025
@vdusek vdusek added documentation Improvements or additions to documentation. bug Something isn't working. labels Jan 16, 2025
@vdusek vdusek added this to the 106th sprint - Tooling team milestone Jan 16, 2025
@vdusek vdusek changed the title Documentation Bug Code sample on home page does not work Jan 16, 2025
vdusek added a commit that referenced this issue Jan 16, 2025
@vdusek
docs: fix home page example
22b36a7 
closes: #912
@vdusek vdusek mentioned this issue Jan 16, 2025
Merged
1 task
vdusek added a commit that referenced this issue Jan 16, 2025
@vdusek
docs: Fix code sample on home page (#913)
6940af4 
### Description

- Fix code sample on home page and move it to a separate Python file.
- Fix code sample in `docs/introduction/07_saving_data.mdx` and move it
to a separate Python file.
- Rm old pydoc-markdown scripts (they live in a [separate
repository](https://github.com/apify/docusaurus-plugin-typedoc-api/tree/master/packages/plugin/python-scripts/docspec-gen)
now).

### Issues

- Closes: #912

### Testing

- Docs were rendered locally.

### Checklist

- [x] CI passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vdusek vdusek

Labels
bug Something isn't working. documentation Improvements or additions to documentation. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Milestone
106th sprint - Tooling team
Development

Successfully merging a pull request may close this issue.

docs: Fix code sample on home page apify/crawlee-python
2 participants
@gdvallance @vdusek