Skip to content

Conversation

@git-pranavbabu
Copy link

This PR updates the custom_hook_workflow example to make the verbose parameter meaningful. Previously, verbose=True was declared but unused, which could confuse new users. Now, the parameter controls whether logging messages and hook outputs are printed.

No existing issues were tagged for this, but it addresses a documentation/example clarity gap.

List of files changed and why
docs/examples/quickstart.py → Updated the custom_hook_workflow function to conditionally print hook messages and crawl output based on the verbose flag. This improves readability and demonstrates how to toggle logging in workflows.

How Has This Been Tested?
Ran the updated custom_hook_workflow locally with verbose=True → confirmed that hook messages and Markdown preview print correctly.

Ran with verbose=False → confirmed that the workflow executes silently without printing logs.

Verified that the crawl still completes successfully and returns structured results.

Checklist
[x] My code follows the style guidelines of this project

[x] I have performed a self-review of my own code

[x] I have commented my code, particularly in hard-to-understand areas

[x] I have made corresponding changes to the documentation (example updated)

[x] I have added/updated unit tests that prove my fix is effective or that my feature works (manual test for verbose toggle)

[x] 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