enthought / enthought/traitsui

Document the [name]_setattr and [object]_[name]_setattr hooks

Open
#1,564 0 comments 0 reactions 0 assignees View on GitHub
component: documentation difficulty: easy type: enhancement
Dominant language
Python
Stars
306
Forks
99
PR merge metrics
No merged PRs in 30d

Description

The documentation mentions that handlers can override `setattr` with something else to do additional processing when setting a value. However it doesn't mention that there are hooks which look for `[name]_setattr` and `[object]_[name]_setattr` methods and use those instead of `setattr` if they exist.

Whether or not this is a good idea, we should document it because occasionally it is the simplest way to get something done.

Contributor guide

No contributing guide indexed for this repository

Research direction

Find the existing documentation that says handlers can override `setattr` and read its surrounding explanation first. Document the `[name]_setattr` and `[object]_[name]_setattr` hooks, including that they are used instead of `setattr` when present; done means the documented behavior matches the issue description.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.