Back to all reviewers

Functional code examples

crewaiinc/crewai
Based on 2 comments
Other

Ensure all code examples in documentation are complete, accurate, and ready to run without modification. Since developers frequently copy and paste examples directly into their projects, include all required parameters and follow consistent patterns.

Documentation Other

Reviewer Prompt

Ensure all code examples in documentation are complete, accurate, and ready to run without modification. Since developers frequently copy and paste examples directly into their projects, include all required parameters and follow consistent patterns.

For example, when demonstrating object creation:

# Correct example with all required parameters
research_task = Task(
    description="Research the latest AI developments",
    expected_output="",  # Include mandatory parameters even if empty
    agent=researcher
)

Documentation structure should maintain consistent patterns across sections, explicitly listing required methods and parameters. This helps developers implement interfaces correctly and reduces the time spent debugging issues caused by incomplete examples.

2
Comments Analyzed
Other
Primary Language
Documentation
Category

Source Discussions