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

Settings: Improve titles #5791

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dhruvisompura
Copy link
Contributor

@dhruvisompura dhruvisompura commented Dec 18, 2024

Description

Addressess #1487

This is a first pass at improving the setting titles displayed in the settings table of contents for built in positron extensions. Any titles prefixed with "Positron" has been removed and ambiguity in extension titles have been addressed. The setting title in the TOC and category title for each setting item has been unified to match where possible. configuration keys have been changed to fix formatting of setting categories where possible.

Extension configuration keys that are prefixed with positron have been left as is for now (excluding theInterpreter settings) since the prefix does not effect the settings UI for now. We may want to address improving the key names for folks who interact with settings via the JSON file. It may be worth tackling after settling on a standard for configuration name formatting for bundled extensions.

The "Positron > Interpreters" settings now live under "Interpreters"/

The following extensions were modified and have the following setting titles in the TOC:

  • open-remote-ssh: Remote SSH
  • positron-notebook-controllers: Notebook Controllers
  • positron-r: R
  • positron-reticulate: Reticulate
  • positron-run-app: App Launcher
  • positron-supervisor: Kernel Supervisor
  • positron-viewer: URL Viewer

QA Notes

We'll want to verify there aren't any regressions with the settings for the extensions listed above, excluding any experimental feature settings.

For the interpreter settings we should verify that changing the automatic startup behavior, restart on crash behavior, and viewing sessions for interpreters are respected as usual.

Screenshots

Screen.Recording.2024-12-17.at.4.06.04.PM.mov

Copy link

github-actions bot commented Dec 18, 2024

E2E Tests 🚀  ?
This PR will run tests tagged with: @critical

@dhruvisompura
Copy link
Contributor Author

To make it easier to review this PR, I would recommend hiding whitespace to only see relevant changes to updating setting titles.

"r.configuration.title": "Positron R Language Pack",
"r.configuration.title-dev": "Positron R Language Pack (advanced)",
"r.configuration.title": "R",
"r.configuration.title-dev": "Advanced Settings",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am considering changing this title to: Advanced since the Settings portion is a bit redundant. Let me know if anyone strongly disagrees. The contribution point docs mention avoiding these terms since they are redundant as well: https://code.visualstudio.com/api/references/contribution-points#contributes.configuration

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

Successfully merging this pull request may close these issues.

1 participant