Content-Length: 268713 | pFad | https://github.com/python/cpython/issues/103143

BC Polish pdb help messages and doc strings · Issue #103143 · python/cpython · GitHub
Skip to content

Polish pdb help messages and doc strings #103143

@gaogaotiantian

Description

@gaogaotiantian

Feature or enhancement

Make pdb's help message less ugly.

Pitch

Currently, the help message of pdb is not pretty.

(Pdb) h a
a(rgs)
        Print the argument list of the current function.
(Pdb) 

a(rgs) is a little bit confusing by itself and the description's indentation is too long(directly from the docstring). commands is even worse.

(Pdb) h commands
commands [bpnumber]
        (com) ...
        (com) end
        (Pdb)

The docstring for each command is not entirely unified (whether there's a space between the command and the description) and for some docstrings they don't match the documentation.

(Pdb) h enable
enable bpnumber [bpnumber ...]

is different than the documentation enable [bpnumber ...]

We can make it better and more user friendly.

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    stdlibStandard Library Python modules in the Lib/ directorytype-featureA feature request or enhancement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions









      ApplySandwichStrip

      pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


      --- a PPN by Garber Painting Akron. With Image Size Reduction included!

      Fetched URL: https://github.com/python/cpython/issues/103143

      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy