Nodes: Add info about implicit input of value to tooltip #120498

Iliya Katushenock · 2024-04-11T01:10:25+02:00

Iliya Katushenock commented

2024-04-11 01:10:25 +02:00

Add note about the fact that socket have implicit input of value to tooltip.
There is no general way to add name or description of implicit field, but
usually this is enough clear from the name of the socket.

Add note about the fact that socket have implicit input of value to tooltip. There is no general way to add name or description of implicit field, but usually this is enough clear from the name of the socket. | | | | -- | -- | | ![image](/attachments/0f5d180e-4165-4a91-a64d-2018cf61df69) | ![image](/attachments/22e7a388-d74d-4cc8-9b85-1f445787732e) |

image.png

17 KiB

image.png

20 KiB

Iliya Katushenock added 6 commits 2024-04-11 01:10:30 +02:00

0ed43f45d6 init

273c0b2a82 progress

3cab0b4ffb cleanup

183eff45ca progress

5f01d6945f Merge branch 'main' into refactor_socket_tooltips

2e168370a2 init

Iliya Katushenock added this to the Nodes & Physics project 2024-04-11 01:10:35 +02:00

Iliya Katushenock added a new dependency 2024-04-11 01:11:16 +02:00

#120497 Nodes: Add default socket value to tooltip of socket

Iliya Katushenock added a new dependency 2024-04-11 01:11:21 +02:00

#120496 Refactor: Nodes: Generate socket tooltips in more generic way

Iliya Katushenock removed a dependency 2024-04-11 01:12:00 +02:00

#120497 Nodes: Add default socket value to tooltip of socket

Iliya Katushenock removed a dependency 2024-04-11 01:12:13 +02:00

#120496 Refactor: Nodes: Generate socket tooltips in more generic way

Iliya Katushenock added 1 commit 2024-04-11 19:18:23 +02:00

1934388bf9 merge main

Iliya Katushenock requested review from Hans Goudey 2024-04-11 19:18:59 +02:00

Iliya Katushenock added 1 commit 2024-04-11 19:19:54 +02:00

148bceb390 merge main

Iliya Katushenock requested review from Jacques Lucke 2024-04-30 16:01:37 +02:00

Jacques Lucke commented

2024-05-01 10:19:50 +02:00

I wonder if "implicit field input" is a useful tooltip to someone who doesn't already know what it is.

Calibrator commented

2024-05-01 11:05:18 +02:00

First-time contributor

I wonder if "implicit field input" is a useful tooltip to someone who doesn't already know what it is.

Luckily I am here to answer this question. No, I have no idea what this means. Under normal circumstances I'd look for more info in the documentation after reading that.

> I wonder if "implicit field input" is a useful tooltip to someone who doesn't already know what it is. Luckily I am here to answer this question. No, I have no idea what this means. Under normal circumstances I'd look for more info in the documentation after reading that.

Iliya Katushenock commented

2024-05-01 11:10:55 +02:00

There is could be 2 option i think:

Send user to manual by this word.
Call this as Auto Field input in UI and have no relatations with manual.

There is could be 2 option i think: 1. Send user to manual by this word. 2. Call this as `Auto Field input` in UI and have no relatations with manual.

Calibrator commented

2024-05-01 13:10:02 +02:00

First-time contributor

There is could be 2 option i think:

Send user to manual by this word.

Call this as Auto Field input in UI and have no relatations with manual.

I just looked up implicit fields online and I believe the 1st option is better. The sites that came up seemed unusual and initially confused me more until I read a little on a couple of them. Finding this information in the relevant area of the documentation would be an immediate click in my head about what implicit fields are.

> There is could be 2 option i think: > 1. Send user to manual by this word. > 2. Call this as `Auto Field input` in UI and have no relatations with manual. I just looked up implicit fields online and I believe the 1st option is better. The sites that came up seemed unusual and initially confused me more until I read a little on a couple of them. Finding this information in the relevant area of the documentation would be an immediate click in my head about what implicit fields are.

Gerstmann Bradley commented

2024-05-01 16:26:36 +02:00

First-time contributor

just to mention I think the information marked here is more descriptive and helpful without introducing new terms.
if this can be done. whichever name will be fine. Whether it's "Default", "Automatic", "Implicit", "Prefilled", etc.

![image](/attachments/631aec5e-dbe1-4489-9902-62e6fcfa5551) just to mention I think the information marked here is more descriptive and helpful without introducing new terms. if this can be done. whichever name will be fine. Whether it's "Default", "Automatic", "Implicit", "Prefilled", etc.

image.png

13 KiB

Iliya Katushenock commented

2024-05-04 19:55:09 +02:00

just to mention I think the information marked here is more descriptive and helpful without introducing new terms.

This is not the best idea to mention default value in description and this is violate current guideline of UI: https://developer.blender.org/docs/features/interface/human_interface_guidelines/tooltips/#the-item-description

I just looked up implicit fields online and I believe the 1st option is better. The sites that came up seemed unusual and initially confused me more until I read a little on a couple of them. Finding this information in the relevant area of the documentation would be an immediate click in my head about what implicit fields are.

I wonder if "implicit field input" is a useful tooltip to someone who doesn't already know what it is.

I don't think that we can do a lot in case if user don't read manual and no one have said this in tutorial that user have seen.
Becuse of this, i think the best that we can do, is:

Send user to manual by this word.
Call this as Auto Field input in UI and have no relatations with manual.

As example of first one, there is: https://docs.blender.org/manual/en/latest/search.html?q=implicit&check_keywords=yes&area=default
As second one case, tooltip can be paraphrased to:

Default value is Implicit Field
Auto field input
Field by default

I'd like to avoid Field word to reuse this for shaders, but this might be okay\

> just to mention I think the information marked here is more descriptive and helpful without introducing new terms. This is not the best idea to mention default value in description and this is violate current guideline of UI: https://developer.blender.org/docs/features/interface/human_interface_guidelines/tooltips/#the-item-description > I just looked up implicit fields online and I believe the 1st option is better. The sites that came up seemed unusual and initially confused me more until I read a little on a couple of them. Finding this information in the relevant area of the documentation would be an immediate click in my head about what implicit fields are. > I wonder if "implicit field input" is a useful tooltip to someone who doesn't already know what it is. I don't think that we can do a lot in case if user don't read manual and no one have said this in tutorial that user have seen. Becuse of this, i think the best that we can do, is: 1. Send user to manual by this word. 2. Call this as `Auto Field input` in UI and have no relatations with manual. As example of first one, there is: https://docs.blender.org/manual/en/latest/search.html?q=implicit&check_keywords=yes&area=default As second one case, tooltip can be paraphrased to: 1. `Default value is Implicit Field` 2. `Auto field input` 3. `Field by default` I'd like to avoid `Field` word to reuse this for shaders, but this might be okay\

This pull request can be merged automatically.

This branch is out-of-date with the base branch

You are not authorized to merge this pull request.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u implicit_input_field_tooltip:mod_moder-implicit_input_field_tooltip

git checkout mod_moder-implicit_input_field_tooltip

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Nodes: Add info about implicit input of value to tooltip #120498

Checkout