Document `TraitType.read_only`

Open Beginner friendly
#410 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

documentation

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!

Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ipython/traitlets

All issues in ipython/traitlets

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.