docs: add a "Human Input" row to the Task Attributes table

[danielfsbarreto]

This info was only available at https://docs.crewai.com/how-to/human-input-on-execution

P.S.: also adjusted formatting of other rows

[joaomdmoura]

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comment for PR #1999

Overview

The changes proposed in this pull request involve the addition of a new "Human Input" attribute to the Task Attributes table in the documentation. This enhancement aims to clarify task configurations and improve user understanding. Overall, the updates are valuable, but a few formatting inconsistencies and clarity issues need addressing.

Positive Aspects

1. The "Human Input" attribute is well-documented, with clear type information and relevant descriptions.
2. The update adheres to the existing table structure and formatting style.
3. This addition enriches task configuration documentation, benefiting users substantially.

Issues & Recommendations

1. Inconsistent Spacing in Table Cells

There are inconsistencies in the spacing after the pipe characters within the table cells. Standardization is recommended for a cleaner appearance.

Current Formatting Example:

| **Name** _(optional)_            | `name`            | `Optional[str]`               | A name identifier for the task.                                                      |
| **Tools** _(optional)_           | `tools`           | `List[BaseTool]`             | The tools/resources the agent is limited to use for this task.                      |

Recommended Consistent Formatting:

| **Name** _(optional)_            | `name`            | `Optional[str]`               | A name identifier for the task.                                                      |
| **Tools** _(optional)_           | `tools`           | `List[BaseTool]`              | The tools/resources the agent is limited to use for this task.                      |

2. Column Alignment

There are minor alignment issues across rows that should be rectified. Thus, I recommend standardizing the column widths:

Example Fix:

| Attribute                        | Parameter         | Type                          | Description                                                                          |
| :------------------------------ | :---------------- | :---------------------------- | :----------------------------------------------------------------------------------- |

3. Description Formatting

Ensuring consistent formatting for the descriptions, especially regarding punctuation and length, is advised.

Suggested Improvement:

| **Human Input** _(optional)_     | `human_input`     | `Optional[bool]`              | Enables human review of the agent's final answer before task completion. Defaults to False. |

Additional Suggestions

1. Example Usage: It would be beneficial to include an example usage of the human_input parameter in the code sections preceding the table. For instance:

   crew = Crew(
       tasks=[
           Task(
               description="Analyze this document",
               expected_output="A detailed analysis",
               human_input=True  # Example of new parameter
           )
       ]
   )

2. Configuration Notes: For completeness, consider adding details about the human input timeout behavior or configuration options to further familiarize users with usage parameters.

Summary of Required Changes

1. Fix spacing inconsistencies in table cells.
2. Standardize column alignment throughout the table.
3. Ensure consistent formatting in descriptions and type definitions.

Impact Analysis

• ✅ Significant improvement in documentation
• ✅ No breaking changes introduced
• ✅ Enhanced understanding of task configurations for users
• ✅ Maintained structure of documentation, ensuring a seamless transition for users

In conclusion, while the changes made in PR #1999 are well-implemented and improve documentation quality, addressing the minor formatting issues will further enhance clarity and usability. The introduction of the "Human Input" parameter is a commendable addition that supports user needs in task management.

[danielfsbarreto]

It would be beneficial to include an example usage of the human_input parameter in the code sections preceding the table.

In my eyes, there is no need for it since it's an optional attribute. Besides, the human input guide contains a practical example already.