ipython / ipython/traitlets

Document `TraitType.read_only`

Open Beginner friendly
#410 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

By searching the repo, I was able to find this description in the changelog:

> Trait attributes initialized with read_only=True can only be set with the set_trait method. Attempts to directly modify a read-only trait attribute raises a TraitError.

This description would be nice to have in docs/docstrings!

Contributor guide

Open the contributing guide

Research direction

Search the repository for TraitType.read_only and the changelog description, then inspect the relevant docs or docstrings. Document that read-only trait attributes can only be set with set_trait and that direct modification raises TraitError; done when this behavior is covered where TraitType is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.