UI: Add tooltip for Poly Build tool #120792

Merged
Brecht Van Lommel merged 1 commits from Bartosz-Kosiorek/blender:polybuild into main 2024-04-22 12:28:01 +02:00
Contributor

With previous implementation the tip was not available.

See attachment for the proposed implementation of tooltip.

With previous implementation the tip was not available. See attachment for the proposed implementation of tooltip.
Bartosz Kosiorek added 1 commit 2024-04-18 20:55:25 +02:00
Bartosz Kosiorek requested review from Brecht Van Lommel 2024-04-18 20:56:19 +02:00
Bartosz Kosiorek requested review from Hans Goudey 2024-04-18 20:56:27 +02:00
Hans Goudey requested changes 2024-04-18 21:02:37 +02:00
@ -770,0 +778,4 @@
kmi_extrude = None
kmi_delete = None
return tip_(
"Use many built operators in an interactive way to add, delete, or move geometry.\n"
Member
  • many -> multiple
  • Remove "built" which is grammatically wrong and doesn't really have meaning here anyway
- `many` -> `multiple` - Remove "built" which is grammatically wrong and doesn't really have meaning here anyway
Bartosz-Kosiorek marked this conversation as resolved
@ -770,0 +780,4 @@
return tip_(
"Use many built operators in an interactive way to add, delete, or move geometry.\n"
"\u2022 %s - Add geometry by moving the cursor close to an element.\n"
"\u2022 %s - Extrude edges at cursor move.\n"
Member

at cursor move doesn't make sense. It could be "on" but that sounds overly technical. Or maybe "Extrude edges by moving the cursor"

`at cursor move` doesn't make sense. It could be "on" but that sounds overly technical. Or maybe "Extrude edges by moving the cursor"
Author
Contributor

thanks, changed.

thanks, changed.
Bartosz-Kosiorek marked this conversation as resolved
Bartosz Kosiorek force-pushed polybuild from 41b12d1bfd to a993e92648 2024-04-18 22:51:00 +02:00 Compare
Bartosz Kosiorek requested review from Hans Goudey 2024-04-18 22:51:37 +02:00
Author
Contributor

All review suggestions were applied.

All review suggestions were applied.
Brecht Van Lommel approved these changes 2024-04-22 11:31:32 +02:00
Brecht Van Lommel merged commit eb4204120b into main 2024-04-22 12:28:01 +02:00
Brecht Van Lommel deleted branch polybuild 2024-04-22 12:28:04 +02:00
Author
Contributor

@brecht @HooglyBoogly What do you think about adding assert to Tips for operators?
So instead of Undefined Operator, the assertion will be thrown.

It will improve the quality of the User Interface by making sure every operator have proper description.

See attachment, what I would like to avoid.

@brecht @HooglyBoogly What do you think about adding `assert` to Tips for operators? So instead of `Undefined Operator`, the assertion will be thrown. It will improve the quality of the User Interface by making sure every operator have proper description. See attachment, what I would like to avoid.

An assert is too intrusive, we don't want Blender to crash for things like this.

We do have some warnings for things like the period at the end of RNA description, and something similar could be done here. But before such noisy warnings are introduced, there would first need to be an effort to make the existing descriptions complete, so only newly added tools without descriptions are brought to attention.

An `assert` is too intrusive, we don't want Blender to crash for things like this. We do have some warnings for things like the period at the end of RNA description, and something similar could be done here. But before such noisy warnings are introduced, there would first need to be an effort to make the existing descriptions complete, so only newly added tools without descriptions are brought to attention.
Author
Contributor

I would love to add tips to all operators and add such kind of warning :-)

Do you know how I could enable such warnings locally?
Where I could find period at the end of RNA description warning implementation?

I tried to add dots to the tips, but I didn't noticed any warnings during compilation.

I would love to add tips to all operators and add such kind of warning :-) Do you know how I could enable such warnings locally? Where I could find `period at the end of RNA description` warning implementation? I tried to add dots to the tips, but I didn't noticed any warnings during compilation.

The RNA warning is implemented in DESCR_CHECK in rna_define.cc. It's only shown when asserts are enabled, which can be done by setting WITH_ASSERT_RELEASE=ON or making a developer/debug build.

Maybe the right place for such a check is wm_operatortype_append__end. But note that some operators may intentionally not have descriptions, or come from add-ons that we don't control.

The RNA warning is implemented in `DESCR_CHECK` in `rna_define.cc`. It's only shown when asserts are enabled, which can be done by setting `WITH_ASSERT_RELEASE=ON` or making a developer/debug build. Maybe the right place for such a check is `wm_operatortype_append__end`. But note that some operators may intentionally not have descriptions, or come from add-ons that we don't control.
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#120792
No description provided.