Skip to content

Explore diffing for notebook cells #99877

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

Closed
miguelsolorio opened this issue Jun 11, 2020 · 10 comments
Closed

Explore diffing for notebook cells #99877

miguelsolorio opened this issue Jun 11, 2020 · 10 comments
Assignees
Labels
notebook notebook-diff under-discussion Issue is under discussion for relevance, priority, approach ux User experience issues
Milestone

Comments

@miguelsolorio
Copy link
Contributor

miguelsolorio commented Jun 11, 2020

Overview

In the editor, we have existing patterns for showing source control (scm) decorations, which is also one of the entry points into source control diffing. This issue is to explore what scm decorations look like within the context of notebook cells.

Existing Patterns

SCM decorators

image

Inline diffs

image

Design Explorations

Kapture 2020-06-12 at 10 33 50

SCM decorator

image

Inline diff

image

@miguelsolorio miguelsolorio added this to the June 2020 milestone Jun 11, 2020
@miguelsolorio miguelsolorio self-assigned this Jun 11, 2020
@miguelsolorio miguelsolorio modified the milestones: June 2020, July 2020 Jun 29, 2020
@miguelsolorio miguelsolorio added the ux User experience issues label Jul 8, 2020
@miguelsolorio miguelsolorio modified the milestones: July 2020, Backlog Aug 3, 2020
@miguelsolorio miguelsolorio modified the milestones: Backlog, August 2020 Aug 17, 2020
@miguelsolorio miguelsolorio changed the title Explore SCM decorations for notebook cells Explore diffing for notebook cells Aug 17, 2020
@miguelsolorio
Copy link
Contributor Author

Here's an updated exploration for diffing:

SCM Indicators

image

Inline peek diff

image

Compare Diff

image

@rebornix
Copy link
Member

Considering there are quite a few open questions for rich diff, we started to explore an enhanced text diff view for notebook to help us understand the best way to present content changes to users. A prototype based on the design mock up from @misolori :

image

@miguelsolorio
Copy link
Contributor Author

Here's the original mockups for the simplified visual diff/enhanced text diff:

image

@claudiaregio
Copy link

Will there be an option/setting to not consider metadata?

@rebornix
Copy link
Member

@claudiaregio we thought about adding something similar to "Show leading/trailing whiteface difference" in normal text diff editor before.

image

In our scenario it would be "Show/hide metadata difference" or so. Is this something close to what you have in mind?

@miguelsolorio
Copy link
Contributor Author

I think having a similar action (toggling metadata) would be great, I'd imagine most users wouldn't want to see this info. I also assume that this would be a setting a user could also set?

@claudiaregio
Copy link

@rebornix close but I thought it would have a better place as a setting like @misolori mentioned, as opposed to something that is surfaced to user as a toggle option.

@rebornix
Copy link
Member

good to hear we are talking about the same thing. Yes sure we will introduce this as a setting and an action/command to toggle its value.

@ayim
Copy link

ayim commented Sep 28, 2020

+1 on the option to toggle metadata.
Will there be an option to show/hide output?

@rebornix rebornix modified the milestones: September 2020, October 2020 Sep 30, 2020
@rebornix rebornix added the under-discussion Issue is under discussion for relevance, priority, approach label Oct 8, 2020
@rebornix rebornix modified the milestones: October 2020, On Deck Oct 26, 2020
@roblourens
Copy link
Member

I think this can be closed, reopen if you want to keep it for anything

@github-actions github-actions bot locked and limited conversation to collaborators Nov 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
notebook notebook-diff under-discussion Issue is under discussion for relevance, priority, approach ux User experience issues
Projects
None yet
Development

No branches or pull requests

6 participants