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

Lazy-docs #919

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Lazy-docs #919

wants to merge 2 commits into from

Conversation

edan-bainglass
Copy link
Member

@edan-bainglass edan-bainglass commented Nov 8, 2024

This PR provides documentation to accompany the changes made in the lazy-loading PR (#802)

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.28%. Comparing base (5949bdf) to head (b8d3997).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #919      +/-   ##
==========================================
+ Coverage   68.26%   68.28%   +0.01%     
==========================================
  Files         110      110              
  Lines        6211     6211              
==========================================
+ Hits         4240     4241       +1     
+ Misses       1971     1970       -1     
Flag Coverage Δ
python-3.11 68.28% <ø> (+0.01%) ⬆️
python-3.9 68.30% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@superstar54 superstar54 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the docs, it's very helpful to get the whole picture of the design, and for reviewing the PR.
I added some quick comments. I am going to review the lazy-loading PR, and may add more comments later.

docs/source/development/architecture.rst Outdated Show resolved Hide resolved
Comment on lines +205 to +206
It is also used by the advanced panel to register the sub-sections of the advanced settings (e.g. magnetization, hubbard, etc.).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a bit more?

Comment on lines +89 to +93
# Controller methods
# EXAMPLE
def _on_trait_change(self, change):
# Update widgets based on model changes
...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you also need to show how the widgets in the UI trigger the model update.

Comment on lines +218 to +221
@tl.observe(tl.All)
def _on_any_change(self, change):
if change and change["name"] != "confirmed":
self._unconfirm()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also explain _on_any_change? What is any?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tl.All watches ALL traits. So ANY trait change triggers this, hence _on_any_change 🙂 Will make it more verbose in the docs 👍

@edan-bainglass edan-bainglass force-pushed the lazy-loading branch 3 times, most recently from 578a997 to a65beed Compare November 14, 2024 05:48
@edan-bainglass edan-bainglass force-pushed the lazy-docs branch 2 times, most recently from 1a4741c to 55fe31a Compare November 14, 2024 19:59
@danielhollas danielhollas self-requested a review November 14, 2024 20:38
Base automatically changed from lazy-loading to main November 20, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants