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

FEAT: transient variables #379

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

FEAT: transient variables #379

wants to merge 1 commit into from

Conversation

tmichela
Copy link
Member

The controversial one 🙈

Transient variables' data and summary are not saved.

Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.00%. Comparing base (a0b022f) to head (885b601).

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.
📢 Have feedback on the report? Share it here.

@tmichela tmichela added the enhancement New feature or request label Jan 30, 2025
Comment on lines +74 to +75
- `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
Copy link
Member

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).

@takluyver
Copy link
Member

Other than quibbling over naming & documentation, this LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants