Documentation inconsistency for VertexGroup.remove #77920

Closed
opened 2020-06-16 17:14:53 +02:00 by Christopher Gearhart · 7 comments

Blender Version
Broken: 2.83
Worked: Never

Short description of error

The VertexGroup.remove method says it expects index, with the description "Remove a vertex from the group". In actuality, though, it expects a sequence and will throw an error if an index is passed.

I believe the more consistent behavior with the rest of the Python API would be for this function to expect a single integer, but I would also be happy with the documentation updating to reflect its current behavior (though if this were to be the case, I think the method would need a new name).

Exact steps for others to reproduce the error

  1. Open the default blend file
  2. With the cube selected & active, add a new vertex group
  3. In edit mode, assign all of the Cube vertices to the new vertex group.
  4. In the Python console, type the following: C.object.vertex_groups- [x].remove(0)
**Blender Version** Broken: 2.83 Worked: Never **Short description of error** The [VertexGroup.remove ](https://docs.blender.org/api/current/bpy.types.VertexGroup.html#bpy.types.VertexGroup.remove) method says it expects `index`, with the description "Remove a vertex from the group". In actuality, though, it expects a sequence and will throw an error if an index is passed. I believe the more consistent behavior with the rest of the Python API would be for this function to expect a single integer, but I would also be happy with the documentation updating to reflect its current behavior (though if this were to be the case, I think the method would need a new name). **Exact steps for others to reproduce the error** 1. Open the default blend file 2. With the cube selected & active, add a new vertex group 3. In edit mode, assign all of the Cube vertices to the new vertex group. 4. In the Python console, type the following: `C.object.vertex_groups- [x].remove(0)`

Added subscriber: @bblanimation

Added subscriber: @bblanimation
Member

Added subscriber: @Blendify

Added subscriber: @Blendify
Member

I think the API is clear here it says it expects an array (list) and the description says "index list" and lists are a sequence data type. I changed the wording to "List of indices" which is a tad more specific sounding.

I think the API is clear here it says it expects an array (list) and the description says "index list" and lists are a sequence data type. I changed the wording to "List of indices" which is a tad more specific sounding.
Member

I am going to leave it up to the #python_api if they want to support passing single int values here.
However, to me, it seems a bit unnecessary simply use a single item list: C.object.vertex_groups- [x].remove([0])

I am going to leave it up to the #python_api if they want to support passing single int values here. However, to me, it seems a bit unnecessary simply use a single item list: `C.object.vertex_groups- [x].remove([0])`

Added subscriber: @ideasman42

Added subscriber: @ideasman42

Accepting both a list of items and a single item is a confusing convention as it's likely not to be followed everywhere.

The documentation should be updated to match functionality.

Accepting both a list of items and a single item is a confusing convention as it's likely not to be followed everywhere. The documentation should be updated to match functionality.

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

Changed status from 'Needs Triage' to: 'Resolved'
Campbell Barton self-assigned this 2021-02-19 15:06:47 +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
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#77920
No description provided.