docs: document `log` trait on `Application` class

Open Beginner friendly
#755 0 comments 1 reaction 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

Start with the Application class documentation at the linked config-api page and inspect traitlets/config/application.py around line 286, where the default is set. Update the documentation to state that the log trait defaults to a Logger named with self.class.name, then check the rendered documentation for the new detail.

Written by the indexing model from the issue text.

Description

The docs for the Application class don't mention the default value of the log trait on Application to be a Logger instance named with self.__class__.__name__. I had to dig through the code to find the line where this default is set. Can we update the documentation here accordingly?

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.