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

Update doc comments on service-connection-provider.ts #13805

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

tsmaeder
Copy link
Contributor

What it does

Add some documentation to make the usage of the local/remote service id's more understandable.

contributed on behalf of STMicroelectronics

How to test

n/a

Follow-ups

Review checklist

Reminder for reviewers

Add some documentation to make the usage of the local/remote service id's more understandable.

contributed on behalf of STMicroelectronics
@tsmaeder tsmaeder requested a review from msujew June 12, 2024 09:53
@tsmaeder
Copy link
Contributor Author

@eneufeld

Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

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

Looks good, two points of improvement on this:

  1. You mention SSH a bunch, but this isn't the only way to use a remote system (dev container being another one, possibly WSL in the future).
  2. I think we can avoid further confusion by specifying that, if the user isn't using a remote system (i.e. normal Electron/Browser system), both LocalConnectionProvider and RemoteConnectionProvider point towards the same system.

@tsmaeder
Copy link
Contributor Author

You mention SSH a bunch, but this isn't the only way to use a remote system

The idea is not to give a complete description of the system here, only an example.

@tsmaeder tsmaeder requested a review from msujew June 26, 2024 07:42
Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

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

Thanks, it's definitely an improvement over the previous doc 👍

@tsmaeder tsmaeder merged commit a2d9251 into master Jun 26, 2024
14 checks passed
@github-actions github-actions bot added this to the 1.51.0 milestone Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants