Skip to content

🔧 Refactor examples for more clarity #102

@Nicoretti

Description

@Nicoretti

Summary

To enhance the accessibility of the example files in our documentation folder, we should refactor them.
The current approach, which utilizes a comment marker to distinguish between basic and advanced examples within a single file, has proven to be somewhat unclear.

Proposed Changes:

  • Split the Existing Example Files: Divide the current example files into two separate files:
    • xxx_basic.py: This file will contain the basic usage example.
    • xxx_advanced.py: This file will focus on more complex scenarios.

The primary goal of this refactoring is to make the example files less confusing when viewed in isolation. By creating distinct files for basic and advanced examples, we aim to facilitate a better understanding and improve the overall user experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    refactoringCode improvement without behavior change

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions