[issue27994] In the argparse help(argparse) prints weird comments instead of good docstrings

py.user report at bugs.python.org
Tue Sep 6 23:20:29 EDT 2016


New submission from py.user:

>>> import argparse
>>> help(argparse)

>>>

Output:

|  add_subparsers(self, **kwargs)
|      # ==================================
|      # Optional/Positional adding methods
|      # ==================================
|  
|  convert_arg_line_to_args(self, arg_line)
|  
|  error(self, message)
|      error(message: string)
|      
|      Prints a usage message incorporating the message to stderr and
|      exits.
|      
|      If you override this in a subclass, it should not return -- it
|      should either exit or raise an exception.
|  
|  exit(self, status=0, message=None)
|      # ===============
|      # Exiting methods
|      # ===============
|  
|  format_help(self)
|  
|  format_usage(self)
|      # =======================
|      # Help-formatting methods
|      # =======================
|  
|  parse_args(self, args=None, namespace=None)
|      # =====================================
|      # Command line argument parsing methods
|      # =====================================
|  
|  parse_known_args(self, args=None, namespace=None)
|  
|  print_help(self, file=None)
|  
|  print_usage(self, file=None)
|      # =====================
|      # Help-printing methods
|      # =====================
|  
|  ----------------------------------------------------------------------
|  Methods inherited from _AttributeHolder:
...


There are no docstrings for methods, hence some internal comments picked up instead.

----------
assignee: docs at python
components: Documentation, Library (Lib)
messages: 274738
nosy: docs at python, py.user
priority: normal
severity: normal
status: open
title: In the argparse help(argparse) prints weird comments instead of good docstrings
type: behavior
versions: Python 3.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue27994>
_______________________________________


More information about the Python-bugs-list mailing list