-
-
Notifications
You must be signed in to change notification settings - Fork 409
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
Renamed widgets subpackage to visualization and restructured modules within it #1462
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report
@@ Coverage Diff @@
## master #1462 +/- ##
==========================================
- Coverage 71.13% 70.00% -1.14%
==========================================
Files 67 67
Lines 5523 5314 -209
==========================================
- Hits 3929 3720 -209
Misses 1594 1594
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good way to restructure the visualization tools. Good work!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good
Loved the detailed description. |
…within it (tardis-sn#1462) * Reorganized widgets & tools modules * Changed import paths as per new subpackage structure * Updated imports in demo notebooks * Added EOF newline to init files
Besides renaming, changed subpackage structure from:
to:
This way I've segregated tools and widgets similar to visualization docs:
tools
widgets
This segregation won't affect how users will import modules (except the name has been changed from
widgets
tovisualization
) since all the important functions/classes are imported in top-levelvisualization
directory's init file. Hence a user need not to know whether a functionality is tool or widget, they will simply import all functionality fromvisualization
subpackage, e.g.:from tardis.visualization import SDECPlotter
from tardis.visualization import LineInfoWidget
The changes in two notebooks in docs reflect the same.
Motivation and Context
Name
visualization
is more inclusive and understandable to wider audience, also docs refer this section same, hence renaming subpackage was essential. Restructure is essential for making it easier for developers to add new modules right way, without creating clutter and maintaining modularity in codebase.How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: