UI: Extend description of Grid, Cube, UV Sphere and Ico Sphere #119331

Merged
Brecht Van Lommel merged 1 commits from Bartosz-Kosiorek/blender:sphere into main 2024-03-19 18:19:30 +01:00
Contributor

Currently when beginner is adding new sphere primitives,
the description is not informative. It is especially visible
for not native English speakers (like me), as it is hard to translate Ico Sphere and UV Sphere.

With this commit I have added basic information what every sphere is,
and basic usage of it. After using this commit, it is much more clear,
when to use each sphere and what is the main differences.

Currently when beginner is adding new sphere primitives, the description is not informative. It is especially visible for not native English speakers (like me), as it is hard to translate Ico Sphere and UV Sphere. With this commit I have added basic information what every sphere is, and basic usage of it. After using this commit, it is much more clear, when to use each sphere and what is the main differences.
Bartosz Kosiorek requested review from Brecht Van Lommel 2024-03-11 17:40:52 +01:00
Bartosz Kosiorek changed title from UI: Extend tip description of UV Sphere and Ico Sphere to UI: Extend description of UV Sphere and Ico Sphere 2024-03-11 17:43:44 +01:00
Bartosz Kosiorek requested review from Weizhen Huang 2024-03-11 18:56:14 +01:00
Hans Goudey requested changes 2024-03-11 19:00:33 +01:00
Dismissed
Hans Goudey left a comment
Member

It's nice not to just repeat the name in the description. But I would remove the last sentence you added to both descriptions. I think that contains too much information for a tooltip. More info here: https://developer.blender.org/docs/features/interface/human_interface_guidelines/tooltips/

It's nice not to just repeat the name in the description. But I would remove the last sentence you added to both descriptions. I think that contains too much information for a tooltip. More info here: https://developer.blender.org/docs/features/interface/human_interface_guidelines/tooltips/
Bartosz Kosiorek force-pushed sphere from 4a8bd3374e to 2d963b283f 2024-03-11 22:55:49 +01:00 Compare
Bartosz Kosiorek requested review from Hans Goudey 2024-03-11 22:55:55 +01:00
Bartosz Kosiorek force-pushed sphere from 2d963b283f to b2217d5d93 2024-03-13 12:54:18 +01:00 Compare

I'd still prefer to leave out "It can be used for texturing". That doesn't really explain anything by itself I think. I guess this is hinting that it's going to work better when UV unwrapping with a spherical projection, but that seems too specific.

I'd still prefer to leave out "It can be used for texturing". That doesn't really explain anything by itself I think. I guess this is hinting that it's going to work better when UV unwrapping with a spherical projection, but that seems too specific.
Bartosz Kosiorek force-pushed sphere from b2217d5d93 to 61c867d675 2024-03-14 07:28:05 +01:00 Compare
Bartosz Kosiorek force-pushed sphere from 61c867d675 to 88f7b47f44 2024-03-14 07:32:12 +01:00 Compare
Bartosz Kosiorek changed title from UI: Extend description of UV Sphere and Ico Sphere to UI: Extend description of Grid, Cube, UV Sphere and Ico Sphere 2024-03-14 09:09:29 +01:00
Hans Goudey reviewed 2024-03-14 15:11:25 +01:00
@ -205,3 +205,3 @@
/* identifiers */
ot->name = "Add Cube";
ot->description = "Construct a cube mesh";
ot->description = "Construct a cube mesh contains six square faces";
Member

Grammar is incorrect here: contains -> containing.

But semantically this is questionable too-- the cube doesn't "contain" faces, is is the faces.
I'm also not convinced this is necessary, is "cube" a word that needs explanation?

Grammar is incorrect here: `contains` -> `containing`. But semantically this is questionable too-- the cube doesn't "contain" faces, is *is* the faces. I'm also not convinced this is necessary, is "cube" a word that needs explanation?
Author
Contributor

Unfortunately in Blender there are different kind of Cubes.

I attached the screenshot with Add Cube (which is Rectangular cuboid), which is confusing.

@HooglyBoogly @brecht
Do you think I should rather change Add Cube to Add Rectangular Cuboid in other case?

Unfortunately in Blender there are different kind of `Cubes`. I attached the screenshot with Add Cube (which is `Rectangular cuboid`), which is confusing. @HooglyBoogly @brecht Do you think I should rather change `Add Cube` to `Add Rectangular Cuboid` in other case?

I would not use "Rectangular Cuboid". It may be technically more correct, but also makes things harder for new users.

I would not use "Rectangular Cuboid". It may be technically more correct, but also makes things harder for new users.
Bartosz-Kosiorek marked this conversation as resolved
@ -509,3 +509,3 @@
/* identifiers */
ot->name = "Add Grid";
ot->description = "Construct a grid mesh";
ot->description = "Construct a regular quadratic grid mesh, which is a subdivided plane";
Member

Apparently it's in the dictionary, but I've never heard "quadratic" used in this way. I'd suggest simplifying the tooltip to just Construct a subdivided plane mesh

Apparently it's in the dictionary, but I've never heard "quadratic" used in this way. I'd suggest simplifying the tooltip to just `Construct a subdivided plane mesh`
Bartosz-Kosiorek marked this conversation as resolved
Bartosz Kosiorek force-pushed sphere from 88f7b47f44 to 17cf5597a7 2024-03-14 16:29:56 +01:00 Compare
Bartosz Kosiorek force-pushed sphere from 17cf5597a7 to f19839266a 2024-03-14 16:34:25 +01:00 Compare
Brecht Van Lommel approved these changes 2024-03-15 18:37:05 +01:00
Hans Goudey approved these changes 2024-03-18 20:25:16 +01:00
Brecht Van Lommel merged commit 18340fa057 into main 2024-03-19 18:19:30 +01:00
Brecht Van Lommel deleted branch sphere 2024-03-19 18:19:33 +01:00
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#119331
No description provided.