Skip to content

Update userDataDir option documentation#1078

Merged
connor4312 merged 2 commits intomicrosoft:mainfrom
Manish-Giri:fixuserDataDirDocs
Aug 24, 2021
Merged

Update userDataDir option documentation#1078
connor4312 merged 2 commits intomicrosoft:mainfrom
Manish-Giri:fixuserDataDirDocs

Conversation

@Manish-Giri
Copy link
Contributor

Adding clarification to the userDataDir section to explain that another browser instance cannot be launched if this option has been specified, as is explained here.

Closes #1072.

@Manish-Giri
Copy link
Contributor Author

Manish-Giri commented Aug 20, 2021

@connor4312 Please take a look when you have a moment, in case the language needs any change, I would be happy to update the PR accordingly.

'Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to "auto", we\'ll detect known cases where this is appropriate.',
'browser.userDataDir.description':
'By default, the browser is launched with a separate user profile in a temp folder. Use this option to override it. Set to false to launch with your default user profile.',
'By default, the browser is launched with a separate user profile in a temp folder. Use this option to override it. Set to false to launch with your default user profile. If `userDataDir` is specified, VS Code can not launch a new browser instance in the default profile if one is already running.',
Copy link
Member

Choose a reason for hiding this comment

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

This phrasing is confusing, it'd be better to say "A new browser can't be launched if an instance is already running from the userDataDir."

@connor4312 connor4312 added this to the August 2021 milestone Aug 24, 2021
@connor4312 connor4312 merged commit 1aaced5 into microsoft:main Aug 24, 2021
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.

Documentation of known issue with userDataDir

2 participants