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

Consolidate notebook setting names #142986

Closed
rebornix opened this issue Feb 14, 2022 · 3 comments
Closed

Consolidate notebook setting names #142986

rebornix opened this issue Feb 14, 2022 · 3 comments
Assignees
Labels
debt Code quality issues

Comments

@rebornix
Copy link
Member

RT

@greazer
Copy link
Member

greazer commented Mar 7, 2022

Not sure exactly what this entails, but would like a rename of the "global notebook toolbar" to be done as well. It's confusing as is.

@rebornix
Copy link
Member Author

rebornix commented Apr 4, 2022

We currently have 25 notebook settings, a good amount of which are named in the pattern notebook.${component}.${feature} but the rest are random. Here is the full list of setting names

// breadcrumbs
notebook.breadcrumbs.showCodeCells

// outline
"notebook.outline.showCodeCells": false

// markup
"notebook.markup.fontSize": 0,

// output
"notebook.output.textLineLimit": 30
"notebook.displayOrder": [],

// diff
"notebook.diff.enablePreview": true,
"notebook.diff.ignoreMetadata": false,
"notebook.diff.ignoreOutputs": false,

// navigation
"notebook.navigation.allowNavigateToSurroundingCells": true

// layout*
"notebook.cellToolbarLocation": { "default": "right" },
"notebook.cellToolbarVisibility": "click",

"notebook.cellFocusIndicator": "gutter",
"notebook.compactView": true,
"notebook.consolidatedOutputButton": true,
"notebook.consolidatedRunButton": false,

"notebook.dragAndDropEnabled": true,
"notebook.editorOptionsCustomizations": {},
"notebook.globalToolbar": true,
"notebook.globalToolbarShowLabel": "always",
"notebook.insertToolbarLocation": "both",
"notebook.lineNumbers": "off",
"notebook.showCellStatusBar": "visible",
"notebook.showFoldingControls": "mouseover",
"notebook.undoRedoPerCell": true,

Some settings can be easily renamed to reflect its category/component:

notebook.displayOrder				---> notebook.output.displayOrder
notebook.cellToolbarLocation		---> notebook.cellToolbar.location
notebook.cellToolbarVisibility		---> notebook.cellToolbar.visible
notebook.insertToolbarLocation		---> notebook.insertToolbar.location
notebook.showCellStatusBar			---> notebook.cellStatusBar.visible

// under discussions
notebook.globalToolbar				---> notebook.globalToolbar.visible
notebook.globalToolbarShowLabel		---> notebook.globalToolbar.showLabel

but the rest are layout related, which don't fall into any category, so look forward to feedbacks on how we are going to name them, or just leave it as is.

"notebook.compactView": true,
"notebook.consolidatedOutputButton": true,
"notebook.consolidatedRunButton": false,
"notebook.lineNumbers": "off",
"notebook.showFoldingControls": "mouseover",
"notebook.undoRedoPerCell": true,

cc @roblourens @microsoft/python-ai-vscode-eng

@rebornix
Copy link
Member Author

rebornix commented Dec 8, 2022

I guess we are beyond the point where we can make the setting names change. Let's try our best to use the pattern for new components/features, or update setting name when we are expanding them.

@rebornix rebornix closed this as completed Dec 8, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Jan 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
debt Code quality issues
Projects
None yet
Development

No branches or pull requests

4 participants
@roblourens @rebornix @greazer and others