blender
/
blender-manual
12
18
Fork 72
Code Issues 71 Pull Requests 8 Projects 1 Releases Wiki Activity

Math node operators need at least basic documentation in the manual #75083

New Issue
Closed
opened 2020-03-25 21:06:27 +01:00 by Wouter Stomp · 8 comments
Wouter Stomp commented 2020-03-25 21:06:27 +01:00
Copy Link

System Information
Operating system: Darwin-19.3.0-x86_64-i386-64bit 64 Bits
Graphics card: AMD Radeon Pro 5500M OpenGL Engine ATI Technologies Inc. 4.1 ATI-3.5.5

Blender Version
Broken: version: 2.83 (sub 6), branch: master, commit date: 2020-03-06 22:46, hash: blender/blender@dcdcc23488
Worked: never

Short description of error
With the increased number of available operators in the math node, there should at least be basic explanations in the manual of what each operator does. Right now, there is a list of operators with links to wikipedia, which is not very helpful if you want to know for example how the compare or the pingpong nodes work. At the very least (and perhaps as a start) the information displayed in the tooltips when hovering over the operators should be in the manual. In most cases, the Wikipedia links are hardly useful at all for practical purposes.

Exact steps for others to reproduce the error
See https://docs.blender.org/manual/en/dev/compositing/types/converter/math.html

**System Information** Operating system: Darwin-19.3.0-x86_64-i386-64bit 64 Bits Graphics card: AMD Radeon Pro 5500M OpenGL Engine ATI Technologies Inc. 4.1 ATI-3.5.5 **Blender Version** Broken: version: 2.83 (sub 6), branch: master, commit date: 2020-03-06 22:46, hash: `blender/blender@dcdcc23488` Worked: never **Short description of error** With the increased number of available operators in the math node, there should at least be basic explanations in the manual of what each operator does. Right now, there is a list of operators with links to wikipedia, which is not very helpful if you want to know for example how the compare or the pingpong nodes work. At the very least (and perhaps as a start) the information displayed in the tooltips when hovering over the operators should be in the manual. In most cases, the Wikipedia links are hardly useful at all for practical purposes. **Exact steps for others to reproduce the error** See https://docs.blender.org/manual/en/dev/compositing/types/converter/math.html
Wouter Stomp commented 2020-03-25 21:06:27 +01:00
Author
Copy Link

Added subscriber: @blenderrocket

Added subscriber: @blenderrocket
Wouter Stomp commented 2020-03-25 21:17:07 +01:00
Author
Copy Link

For reference, the vector math node has much better documentation. Also it mentions the dynamic inputs the math node now also has.

For reference, the vector math node has much better documentation. Also it mentions the dynamic inputs the math node now also has.
Brecht Van Lommel commented 2020-03-26 11:36:30 +01:00
Owner
Copy Link

Added subscriber: @CharlieJolly

Added subscriber: @CharlieJolly
Alaska commented 2020-04-07 11:41:58 +02:00
Member
Copy Link

Added subscribers: @Blendify, @Alaska

Added subscribers: @Blendify, @Alaska
Alaska commented 2020-04-07 11:41:58 +02:00
Member
Copy Link

@Blendify I'm thinking about taking on this task. What do you think about this layout for separating the difference sections?
Screenshot from 2020-04-07 21-40-38.png
New system at the top. Old system at the bottom.

If you have any changes you'd like to recommend, please say so and include an example in reStructuredText syntax

@Blendify I'm thinking about taking on this task. What do you think about this layout for separating the difference sections? ![Screenshot from 2020-04-07 21-40-38.png](https://archive.blender.org/developer/F8454393/Screenshot_from_2020-04-07_21-40-38.png) New system at the top. Old system at the bottom. If you have any changes you'd like to recommend, please say so and include an example in reStructuredText syntax
Alaska commented 2020-04-07 13:52:51 +02:00
Member
Copy Link

@CharlieJolly @Blendify

I've created a patch for this issue. Would love to hear your feedback plus see additions from people that know more than I do. D7366

@CharlieJolly @Blendify I've created a patch for this issue. Would love to hear your feedback plus see additions from people that know more than I do. [D7366](https://archive.blender.org/developer/D7366)
Aaron Carlisle commented 2020-04-13 21:52:00 +02:00
Member
Copy Link

Changed status from 'Needs Triage' to: 'Resolved'

Changed status from 'Needs Triage' to: 'Resolved'
Aaron Carlisle self-assigned this 2020-04-13 21:52:00 +02:00
Aaron Carlisle commented 2020-04-13 21:52:00 +02:00
Member
Copy Link

rBM6499

rBM6499
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
main
blender-v4.1-release
blender-v4.0-release
blender-v3.6-release
blender-v3.5-release
blender-v3.3-release
blender-v2.93-release
v3.5
v3.4
v3.3
v3.2
v2.93
v3.1
v3.0
v2.92
v2.78
Labels
Clear labels   
Meta
Good First Issue

  
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 & Devices

  
Module
Python API

  
Module
Rendering & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
User Interface

  
Module
VFX & Video

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Information 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 Label
Meta
Good First Issue
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 & Devices
Module
Python API
Module
Rendering & Cycles
Module
Sculpt, Paint & Texture
Module
User Interface
Module
VFX & Video
Priority
High
Priority
Low
Priority
Normal
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Information 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
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
Aaron Carlisle
4 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-manual#75083
No description provided.
Delete Branch "%!s(<nil>)"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?