🔧 Refactor examples
for more clarity
#102
Labels
refactoring
Code improvement without behavior change
examples
for more clarity
#102
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:
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.
The text was updated successfully, but these errors were encountered: