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

Add descriptions/tooltips to properties in the Import dock #2041

Closed
Calinou opened this issue Dec 28, 2020 · 0 comments · Fixed by godotengine/godot#49524
Closed

Add descriptions/tooltips to properties in the Import dock #2041

Calinou opened this issue Dec 28, 2020 · 0 comments · Fixed by godotengine/godot#49524

Comments

@Calinou
Copy link
Member

Calinou commented Dec 28, 2020

See also #1339 and #1955.

Describe the project you are working on

The Godot editor 🙂

Describe the problem or limitation you are having in your project

Properties in the Import dock currently can't have any descriptions:

Import dock tooltip for flags/repeat

A lot of properties don't behave in an obvious manner (such as lossy compression quality for textures). This makes it important to document those properties in an easily accessible way.

Describe the feature / enhancement and how it helps to overcome the problem or limitation

When hovering a property in the Import dock, display a tooltip with documentation.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Figure out a way to document import properties in the class reference by exposing them somehow. Maybe expose dummy classes for each imported resource type so they can be listed in the class reference?

If this enhancement will not be used often, can it be worked around with a few lines of script?

No, as this is core editor/documentation system functionality.

Is there a reason why this should be core and not an add-on in the asset library?

This is core editor/documentation system functionality.

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

Successfully merging a pull request may close this issue.

2 participants