search

SanderRonde / VSCode-Gerrit

Gerrit plugin for VSCode
https://marketplace.visualstudio.com/items?itemName=SanderRonde.vscode--gerrit
MIT License
29 stars 17 forks source link

Documentation Needed #29

Closed 29ayush closed 1 year ago

29ayush commented 1 year ago

Hi can you add some documentation.

Like What's the difference between quick checkout and checkout, and other usage documentation.

Also one issue I am facing is code browsing, I want to able to code browse when in review panel mode. If I see that a new function is added I want to be able to press F12 and see the usage, go to file . I don't want to open the file myself, and then browse, because then I can't see the changes highlighted in green. Is it possible?

SanderRonde commented 1 year ago

Regarding your first point. You're definitely right, documentation is quite sparse at the moment. I will add some more. What would you think would be a good place to add this documentation? The readme file (which is readable here and on the extension installation page in-editor) or somehow cram it inside the extension?

For your second point, I'm pretty sure that's not possible now. It's a feature I also miss quite often but it just seems to be a limitation of VSCode's diff view. If it's going to happen, the VSCode team is the one to do it since I'm pretty sure an extension can't fix that.

29ayush commented 1 year ago

Yes. Readme would be the best place.

For your second point, I'm pretty sure that's not possible now. It's a feature I also miss quite often but it just seems to be a limitation of VSCode's diff view. If it's going to happen, the VSCode team is the one to do it since I'm pretty sure an extension can't fix that.

I see. that's sad.

SanderRonde commented 1 year ago

Thanks for the info! Will try to update the readme some time this week or next week.

29ayush commented 1 year ago

As a workaround for code browsing, Is it possible to have a redirector someplace ? I mean let's say I have checked out the change, and I am doing a diff view, (review panel), I am on Line206:FileXyz, then something I can click which in a new tab opens FileXyz:Line206.

I don't see an option currently I am allowed to open by right click modified file and original file, but they don't apparently correspond to actual local file.

SanderRonde commented 1 year ago

I'm pretty sure that's also not possible. The right-click menu in diff files is very limited so I doubt extensions can add to it. Would also be kind of hard to put such a button somewhere else, since it should ideally just open the highlighted line.

SanderRonde commented 1 year ago

I've added some more documentation in the README file so I've closed the issue for now. Please re-open it if could still be improved or if you feel your other question has not been fully answered.