-
Notifications
You must be signed in to change notification settings - Fork 100
Move data summary setting from "positron" to "dataExplorer" #7263
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
Conversation
Signed-off-by: Dianyi Yang <[email protected]>
Might make sense to have a |
It might make sense to use a That said, this PR intentionally uses the If we were to use the |
I'll quote from our internal docs here (not available currently for external contributors -- apologies!), for some guidance:
|
@juliasilge The doc seems to be in this PR's favour over my original naming! Just to avoid any confusion, the original naming ( Glad to know that this PR accidentally follows Positron's internal naming convention, as you just mentioned. This saves some hassle as in another PR of mine (#7266), which is awaiting review, also uses the |
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.
Commenting inline.
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.
Commenting inline.
👋 I saw you requested changes and mentioned inline comments — just checking in case they didn’t get submitted properly (I didn't see any comments). Happy to revise once I can see the feedback!
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've made some comments in the PR. These changes shouldn't be made as they are. We will review the use of Positron: Some Setting Name
internally and decide what we're going to do about this.
src/vs/workbench/services/positronDataExplorer/browser/positronDataExplorerSummary.ts
Outdated
Show resolved
Hide resolved
src/vs/workbench/services/positronDataExplorer/browser/positronDataExplorerSummary.ts
Outdated
Show resolved
Hide resolved
@@ -16,9 +16,9 @@ import { PositronDataExplorerLayout } from './interfaces/positronDataExplorerSer | |||
|
|||
// Key for the configuration setting | |||
export const USE_POSITRON_DATA_EXPLORER_SUMMARY_COLLAPSED_KEY = | |||
'positron.dataExplorerSummaryCollapsed'; | |||
'explorer.summaryCollapsed'; |
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.
This is not an explorer
setting. It's a dataExplorer
setting, so the name should be dataExplorerSummaryCollapsed
. Whether or not it should be prefixed with positron
should be reviewed, but at the moment, we have many settings that appear as Positron: Remote Host Experimental
, and so on. So this change is not approved as it is.
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.
Ahh this makes sense. But, the reason I made this change was that Explorer
was the closest entry I could found in the tree view (see the screenshot in #7263 (comment)) If we do dataExplorer
, the user won't be able to find it from the tree, unless we add a separate dataExplorer
to the tree view.
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.
export const USE_POSITRON_DATA_EXPLORER_SUMMARY_LAYOUT_KEY = | ||
'positron.dataExplorerSummaryLayout'; | ||
'explorer.summaryLayout'; |
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.
This is not an explorer
setting. It's a dataExplorer
setting, so the name should be dataExplorerSummaryLayout
. Whether or not it should be prefixed with positron
should be reviewed, but at the moment, we have many settings that appear as Positron: Remote Host Experimental
, and so on. So this change is not approved as it is.
Hi. I approved the PR by mistake, so I had to undo this. Please see my comments for the individual changed lines. For Positron-specific localizations, we prefix every key with As for the settings, they are Thanks! |
@softwarenerd Sure! I just made the changes (I allowed edits by maintainers so feel free to overwrite my code). My worry was that if we switched to the |
Hi @kv9898, I've made a few adjustments to the settings and added a new Data Explorer feature area to the table of contents for settings. I've pushed these changes to your branch / PR. The result: ![]() Your PR helped us clarify these settings. Thanks! |
* Fix typos * Mimic R's scipen in data explorer * update setting names in line with posit-dev#7263
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.
LG!
@softwarenerd please can you merge this in, since I do not have write access? |
* Fix typos * Mimic R's scipen in data explorer * update setting names in line with posit-dev#7263
@juliasilge Many thanks! Please may I have my other PR (#7390) assigned a reviewer when convenient? |
This is an internal, non-fork PR applying the commits from #7263, because of the problems outlined in #6628 Looking good!  ### Release Notes #### New Features - N/A #### Bug Fixes - Improved discoverability of Data Explorer settings, thanks to @kv9898 --------- Signed-off-by: Dianyi Yang <[email protected]> Co-authored-by: Jonathan McPherson <[email protected]> Co-authored-by: Dianyi Yang <[email protected]> Co-authored-by: Dianyi Yang <[email protected]> Co-authored-by: Brian Lambert <[email protected]>
Closed by #7390 |
Release Notes
New Features
Bug Fixes
QA Notes