-
Notifications
You must be signed in to change notification settings - Fork 14
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
Improvements to CLI #33
Conversation
To hopefully make it clearer that this doesn't have any ongoing link to that URI
``` | ||
|
||
Tip: Use the `--latest-only` option, to only show the latest versions of cached notebooks. |
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.
What do you think about the default being --latest-only
and having a flag like --include-history
instead?
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.
The reason why I'm hesitant to use --include-history
is that the terminology is not strictly true in how the cache actually operates. Filtering for a certain Origin URI
and sorting by Created
does not guarantee to show a history for that URI; for example if you start changing file names of notebooks, or for a specific example:
- create a git repository with
notebook.ipynb
and cache it - switch the branch of the git repository, modify
notebook.ipynb
and cache that - switch back to the original git branch
Assuming the actual cache isn't committed to git, you now have two versions of notebook.ipynb
in the cache and the older one is actually the latest for the branch you are currently on.
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.
#34 could be an alternative way to show only particular records
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.
Yeah, that makes sense. I am just trying to think of the most common use-case, and generally speaking we should be tailoring the default UI around the common use-cases. I think it's much more common for someone to think "I want to see a list of the notebooks that are in the cache" than for them to also think "and I want to see values for every version that I have ever cached for a given notebook".
Though your branching example is a tricky one, that would definitely confuse people if they only had a single notebook listed in the cache by default even though it was out of date:-/
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.
I’m definitely open to some form of solution, but it should be carefully considered what the balance is between ease-of-use and compliance with underlying logic
See commit messages and README
fixes #23, fixes #24, fixes #26, fixes #32