You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It may be helpful to add a more explicit explanation of how to integrate the examples into real applications in the example docstrings. We should explain that the examples are good for trying out a concept, but for specific use cases, users should start by copying the example code into a new python file and modifying it for the use case there.
Current Behavior
Right now, the example docstrings only explain how to run the examples, and it's not clear how to start integrating the examples into more specified applications. Improved docstrings may help users better understand how to get started modifying the code to work for their needs.
The text was updated successfully, but these errors were encountered:
Expected Behavior
It may be helpful to add a more explicit explanation of how to integrate the examples into real applications in the example docstrings. We should explain that the examples are good for trying out a concept, but for specific use cases, users should start by copying the example code into a new python file and modifying it for the use case there.
Current Behavior
Right now, the example docstrings only explain how to run the examples, and it's not clear how to start integrating the examples into more specified applications. Improved docstrings may help users better understand how to get started modifying the code to work for their needs.
The text was updated successfully, but these errors were encountered: