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

Code editor improvement: quick documentation #27607

Closed
smedelyan opened this issue Apr 2, 2019 · 8 comments
Closed

Code editor improvement: quick documentation #27607

smedelyan opened this issue Apr 2, 2019 · 8 comments

Comments

@smedelyan
Copy link

smedelyan commented Apr 2, 2019

Currently, we can use Lookup Symbol or Search Help to look for documentation of everything. It would be nice to have that documentation in popup rather than a separate window / tab.
See an example: Quick Documentation in IntelliJ IDEA

@Duroxxigar
Copy link
Contributor

I just want to throw my voice out there for this. I actually like the way it is currently implemented more. Perhaps a toggle?

@smedelyan
Copy link
Author

@Duroxxigar with this implemented you will still be able to read documentation exactly in the same way as you have been reading before. This is just an additional feature. Wanna see docs of a method? Ok, Ctrl + Q (or whatever) and it's shown in popup. No need to look through the whole doc-page with other functions and skim it for the one you looked for (it may be in the very end so the scrolling may not be precise enough). I do believe this is much more useful as it is, so to say, right in the context where you code.

@Calinou
Copy link
Member

Calinou commented Apr 7, 2019

I agree this is would be a pretty useful feature, as it prevents a context switch when you're just looking at the documentation of a single function. It could also be enabled when hovering properties/methods with the mouse (with a small delay).

@Duroxxigar
Copy link
Contributor

@smedelyan I wasn't voting in no of it. I just wanted to voice my opinion about the current implementation.

@smedelyan
Copy link
Author

smedelyan commented Apr 12, 2019

@Duroxxigar alright=) I do love the way Godot provides its documentation right now as well:) That's definitely much better than, say, Unity does

@Jummit
Copy link
Contributor

Jummit commented Jun 14, 2019

Could be implemented with a custom tooltip.

@echebbi
Copy link

echebbi commented Feb 23, 2020

Is there any progress on this? I have seen several GitHub issues asking for in-code documentation in GDScript (JavaDoc / Docstrings like) and appropriate support in Godot's Script Editor but it looks like nothing has changed since.

I would love to have this feature into Godot; is there anything that can be done to push it forward?

@Calinou
Copy link
Member

Calinou commented Apr 30, 2020

Closing in favor of godotengine/godot-proposals#765, as feature proposals are now tracked in the Godot proposals repository.

I would love to have this feature into Godot; is there anything that can be done to push it forward?

Well, someone needs to implement it 🙂

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

No branches or pull requests

6 participants