-
Notifications
You must be signed in to change notification settings - Fork 2
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
FEAT: transient variables #379
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #379 +/- ##
==========================================
+ Coverage 75.99% 76.00% +0.01%
==========================================
Files 33 33
Lines 5473 5477 +4
==========================================
+ Hits 4159 4163 +4
Misses 1314 1314 ☔ View full report in Codecov by Sentry. |
- `transient` (bool): whether or not to save the variable's result to the | ||
database. This is useful for e.g. intermediate results. By default variables |
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.
"whether or not to save" implies that True
means save.
I imagine most users will be familiar with the word transient anyway, so the flip will be obvious, but maybe we could either reword this ("whether or not to skip saving"), or change the sense of the parameter (saved=False
).
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.
do you have a preference? transient
vs saved
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.
Maybe a slight meaning towards saved
, which is maybe clearer about the difference from regular variables. But I assume most variables will be saved, so calling the exceptions 'transient' rolls off the tongue better than 'unsaved'. 🤷
Other than quibbling over naming & documentation, this LGTM |
The controversial one 🙈
Transient variables' data and summary are not saved.