hoffstadt / hoffstadt/DearPyGui

Design: Deprecated methods moving to configure_app()

Open
#2,236 1 comment 0 reactions 0 assignees View on GitHub
state: pending type: docs
Dominant language
C++
Stars
15.6k
Forks
783
PR merge metrics
No merged PRs in 30d

Description

Greetings,

I was recently stranded for several hours on a flight without internet and The Docs, but the desire to put together a gui with dpg. I found that the only reasonable way to learn about the capabilities of `configure_app()` was to read the deprecated convenience methods that wrap around it:
https://github.com/hoffstadt/DearPyGui/blob/49383185649020bb8d17bd7b30ad40f022a19f6f/dearpygui/_deprecated.py#L45

Because `configure_app()` disappears into compiled code the local documentation on usage is sparse.

The item registry explorer helps with this slightly, but it does not reference everything related to an item, for example the color of a color_button.

If I am seeing things right here, then I recommend removing the deprecations in favor of maintaining the explanatory convenience uses of the `configure_app()` api.

Cheers,
Joe

Contributor guide

Open the contributing guide

Research direction

Read dearpygui/_deprecated.py at the linked revision and compare its convenience methods with configure_app(). Then inspect the local documentation and item registry explorer coverage described in the report. Done means a decided approach for the deprecated methods and clearer guidance for configure_app() usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.