Differential D12640
Add node tooltips to Geometry Nodes primitives Authored by Nikhil Shringarpurey (Nikhil.Net) on Sep 26 2021, 12:39 AM.
Details Building on the awesome work in D12607 by @Johnny Matthews (guitargeek), this Diff adds tooltips to all of the inputs for the default primitives nodes where they make sense. I'm doing a pass through other nodes to see where tooltips would add value, but figured this was a quick win.
Diff Detail
Event TimelineComment Actions Thanks! I also can't think of a downside of having tooltips on every socket. We just might want to have a global variable that contains a common tooltip for e.g. geometry input/output. This would make it easier to change later on if necessary. Comment Actions Understood - I was working on more nodes after this diff and realized perhaps a best practice would be to use the phrasing from the documentation itself. That way, if improvements are needed for clarity, it would encourage the documentation to also get updated at the same time. I can certainly do that also. Comment Actions As an example, I think a tooltip on the output of a primitive node that says "The output mesh" isn't worth anyone's time-- translators, developers, the space it takes in the compiled application, the line it takes in the source file, etc. However, I think there is still room for more tooltips in these files. Things like offset, inner and outer radius, reverse, could have helpful explanations.
Comment Actions Updates to all curve and mesh primitives to align with exact phrasing in the Blender manual. There are a couple small changes where the manual text is missing or poorly worded, and I will submit a separate patch to the manual to correct those. Also note that the Mesh Line Node does some weird stuff with node inputs - instead of hiding/showing based on the mode set in the drop-down, it actively renames node labels. This makes adding consistent tooltips a challenge, and may indicate bad architecture compared to other GeoNodes. Comment Actions Forgot to mark comments as closed. These now use the same wording as the Blender Manual. Comment Actions Thanks for continuing to work on this! I left some fairly detailed comments, I think these will be a huge help though, especially when we get to more complex nodes. I asked in the #user-interface-module chat if we generally prefer "The" at the start of descriptions for properties, since I didn't remember. I find myself preferring one or the other depending on the context.
Comment Actions Great feedback. I'll incorporate these. Since I'm also trying to keep the Blender Manual updated in lockstep with this, I'll also start generating a child Differential to this one that focuses on updating the manual to be consistent. Comment Actions Diff addressing all of Hans' comments. Following style guidance, I did add periods to some sentences as requested and completed the second sentence of each pair with a period also, as it just looks ugly (and is bad grammar style) to have one period-terminated sentence and another hanging there with nothing. Comment Actions The last period is added automatically by the tooltip system, so if you add it manually in the tooltip, there will be two periods. This comment was removed by Nikhil Shringarpurey (Nikhil.Net). Comment Actions Looking close. N_ should be added to the descriptions too.
Comment Actions Added comments. I'll add the N_ once you're good with the changes as they stand.
Comment Actions
Comment Actions @Hans Goudey (HooglyBoogly) given the UI thread comments, I think this is to good to commit as-is. The child diff for updating the manual is in sync as well. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||