enthought / enthought/traits

Rename ObserverGraph.node to ObserverGraph.observer

Open
#1,518 1 comment 0 reactions 0 assignees View on GitHub
component: core type: refactor
Dominant language
Python
Stars
462
Forks
90
PR merge metrics
No merged PRs in 30d

Description

Suggestion for readability and accessibility of the observe code to newcomers: rename `ObserverGraph.node` to `ObserverGraph.observer`. "node" is a generic term that doesn't describe well what it refers to. The object referred to is an `IObserver` instance, which doesn't always exist as a node on a graph - it's used by the `ObserverExpression`, too.

This would be backwards compatible change from the point of view of Traits users: `ObserverGraph` isn't directly accessible to users, and the `ObserverGraph` class is not part of any published API; it would only affect developers of Traits itself.

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the codebase for ObserverGraph.node and inspect the related ObserverGraph and ObserverExpression references. Rename the internal attribute consistently, then run the relevant existing test suite and confirm that no references to ObserverGraph.node remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.