Skip to content
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.

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

docs: Update http crawler docs #612

Closed

Conversation

belloibrahv
Copy link

Description

This PR refactors the HttpCrawler class to ensure conformity with Google's style docstring guidelines. The updates are focused on improving documentation clarity and structure, without altering the functionality of the code.

Key changes include:

  • Enhanced the class-level docstring for HttpCrawler to provide a clear overview of its purpose and functionality.
  • Added usage examples with correct code snippets to demonstrate how to instantiate and run the HttpCrawler.
  • Standardized method docstrings to include detailed descriptions of parameters, return values, and behavior, following Google's style guideline.

Issues

Testing

The changes were tested to ensure:

  • The revised docstrings are accurate and reflect the current functionality.
  • No unintended changes were introduced that would affect the behavior of the HttpCrawler.
  • Code examples provided in the docstrings execute correctly and align with the intended usage.

Checklist

  • CI passed

@belloibrahv belloibrahv changed the title Update http crawler docs docs:Update http crawler docs Oct 22, 2024
@belloibrahv belloibrahv changed the title docs:Update http crawler docs docs: Update http crawler docs Oct 22, 2024
@belloibrahv belloibrahv deleted the update-http-crawler-docs branch October 22, 2024 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve API docs of public components
1 participant