Cleanup: Fix incorrectly formatted multi-line docstring #105474

Merged
Hans Goudey merged 1 commits from pioverfour/blender:dp_fix_messages into blender-v3.5-release 2023-03-06 14:10:33 +01:00
Member

This has the effect that the message is cut off at the end of the
first line. I copied the solution from other similar docstrings
elsewhere in the code.

As far as my regex-fu can tell, there are no other occurrences of this
in the codebase.

Issue reported by Joan Pujolar in #43295.


It looks like this in the UI:
image

I submitted the previous PR too quickly, sorry about that.

This has the effect that the message is cut off at the end of the first line. I copied the solution from other similar docstrings elsewhere in the code. As far as my regex-fu can tell, there are no other occurrences of this in the codebase. Issue reported by Joan Pujolar in #43295. ----- It looks like this in the UI: ![image](/attachments/8a74e61a-a6ed-4f49-bbab-ab58eed344d5) I submitted the previous PR too quickly, sorry about that.
Damien Picard added 1 commit 2023-03-05 23:44:30 +01:00
8b082cebb3 Cleanup: Fix incorrectly formatted multi-line docstring
This has the effect that the message is cut off at the end of the
first line. I copied the solution from other similar docstrings
elsewhere in the code.

As far as my regex-fu can tell, there are no other occurrences of this
in the codebase.

Issue reported by Joan Pujolar in #43295.
Damien Picard added this to the User Interface project 2023-03-05 23:44:40 +01:00
Damien Picard requested review from Hans Goudey 2023-03-05 23:44:55 +01:00
Member

I have no clue what this tooltip means, but indeed, looks like a problem.

However, are you sure the part in parentheses makes sense for a UI description? The "user specified" part makes me suspicious.

I have no clue what this tooltip means, but indeed, looks like a problem. However, are you sure the part in parentheses makes sense for a UI description? The "user specified" part makes me suspicious.
Author
Member

I had a look. Basically there are two Freestyle line modifiers which can be used to modify the lines based on a distance: Distance from Object and Distance from Camera. So basically the tooltip should be understood as “(either the target object [for Distance from Object], or the active camera [for Distance from Camera])”.

It does make sense in context :D

I had a look. Basically there are two Freestyle line modifiers which can be used to modify the lines based on a distance: Distance from Object and Distance from Camera. So basically the tooltip should be understood as “(either the target object [for Distance from Object], or the active camera [for Distance from Camera])”. It does make sense in context :D
Member

Okay, I trust you here :) Thanks for looking into it

Okay, I trust you here :) Thanks for looking into it
Hans Goudey approved these changes 2023-03-06 00:17:37 +01:00
Hans Goudey merged commit 214b24e025 into blender-v3.5-release 2023-03-06 14:09:56 +01:00
Damien Picard deleted branch dp_fix_messages 2023-03-06 20:38:24 +01:00
Sign in to join this conversation.
No reviewers
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
2 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#105474
No description provided.