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

Improve documentation on passing objects across RPC #13238

Merged
merged 2 commits into from
Jan 18, 2024

Conversation

martin-fleck-at
Copy link
Contributor

@martin-fleck-at martin-fleck-at commented Jan 4, 2024

What it does

Improves documentation.
Fixes #13224

How to test

  • Read and see if it is better than before ;-)

Follow-ups

Review checklist

Reminder for reviewers

doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
doc/Plugin-API.md Outdated Show resolved Hide resolved
@martin-fleck-at martin-fleck-at force-pushed the issues/13224 branch 2 times, most recently from b764e13 to 5e4d56a Compare January 17, 2024 09:52
@martin-fleck-at
Copy link
Contributor Author

@tsmaeder @jcortell68 I pushed an updated version of the documentation. It would be really great if you could have a very quick read through it to see if there is still something unclear or missing from your point of view. Thank you!

@jcortell68
Copy link
Contributor

@tsmaeder @jcortell68 I pushed an updated version of the documentation. It would be really great if you could have a very quick read through it to see if there is still something unclear or missing from your point of view. Thank you!

The new text/description looks perfect to me. Thank you! I know this was a bit of a pain to pin down, but if it was difficult for us to do that, imagine the Theia newbie working on API trying to figure that out on his own. This will help a lot.

@martin-fleck-at
Copy link
Contributor Author

@jcortell68 @tsmaeder If the documentation looks good to you, please approve the PR so I can merge it, thank you!

@jcortell68
Copy link
Contributor

jcortell68 commented Jan 17, 2024

@jcortell68 @tsmaeder If the documentation looks good to you, please approve the PR so I can merge it, thank you!

Ah. Didn't think my approval was technically needed since I'm not a maintainer/committer in the project. Maybe Theia works differently than other open source projects I've worked with. Done.

@martin-fleck-at
Copy link
Contributor Author

@jcortell68 It is technically not needed but I like to get a clean state on the PR before merging it, also for history-preserving reasons ;-)

@martin-fleck-at martin-fleck-at merged commit ff8148f into master Jan 18, 2024
14 checks passed
@martin-fleck-at martin-fleck-at deleted the issues/13224 branch January 18, 2024 09:05
@github-actions github-actions bot added this to the 1.46.0 milestone Jan 18, 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.

Plugin API markdown file needs updating
4 participants