Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 Refactor examples for more clarity #102

Open
Nicoretti opened this issue Mar 13, 2024 · 0 comments
Open

🔧 Refactor examples for more clarity #102

Nicoretti opened this issue Mar 13, 2024 · 0 comments
Labels
refactoring Code improvement without behavior change

Comments

@Nicoretti
Copy link
Member

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.

@Nicoretti Nicoretti added the refactoring Code improvement without behavior change label Mar 13, 2024
@Nicoretti Nicoretti mentioned this issue Mar 13, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Code improvement without behavior change
Projects
None yet
Development

No branches or pull requests

1 participant