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

♻️ CrawlResult model: add pydantic fields and descriptions #901

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gbe3hunna
Copy link

Summary

Added pydantic.Field with descriptions to the CrawlResult class to let the model be self-explanatory.
Descriptions in the codebase would have helped me during my first steps with the library.

List of files changed and why

crawl4ai/models.py - Added pydantic.Field with descriptions to the CrawlResult class to let the code be self-explanatory.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added/updated unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

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.

2 participants