Insufficient Examples in UserGuide for Commands with Variable Inputs

[bbryant824]

Bug Report: Insufficient Examples for Commands with Variable Inputs

Title: User Guide provides too few examples for commands like update and edit that allow varied input combinations.

---

Description

The User Guide includes basic examples for commands like update and edit, but it fails to provide enough examples to cover the wide range of input combinations these commands support. These commands can take multiple optional parameters, and the lack of comprehensive examples makes it difficult for users to understand their full flexibility and usage.

---

Expected Behavior

• The User Guide should include multiple examples for commands like update and edit, showcasing different valid input combinations.
• Examples should demonstrate minimal, partial, and full parameter usage to help users understand how the commands behave under various scenarios.

For example:

• edit could show examples with one optional field, multiple optional fields, and invalid cases.
• update could show examples with required fields only, with optional fields added, and edge cases like adding/removing attendees.

---

Actual Behavior

• The edit command only includes a single example with two parameters:

No examples demonstrate using fewer parameters or error handling for missing inputs.

• The update command similarly lacks examples for different input combinations, such as updating only the event location or adding/removing attendees.

---

Severity

severity.Low

---

Type

type.DocumentationBug

---

Why This Is a Problem

• Incomplete Understanding for Users: Without diverse examples, users may not realize the full potential of these commands or how to use them effectively.
• Error-Prone Usage: Users might misinterpret how many and which parameters are necessary, leading to incorrect command inputs.
• Reduced Usability: Limited examples make it harder for users to experiment confidently with different input combinations.

---

Suggestions for Improvement

• For update`, include examples like:

  update -i 1 -l New Location  
  update -i 2 -a 1 2 -r 3  
  update -i 3 -n Party -sd 2025-01-01  
  

Provide more examples with pictures to let user understand how to use them properly.

2. Clarify Parameter Flexibility:

• Indicate which parameters are optional and how commands behave with minimal vs. full input.

3. Include Edge Case Scenarios:

• Demonstrate what happens when no optional parameters are provided or invalid parameters are used.

---