VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2025-12-10 05:51:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Consider __doc__ always Optional. (#641)

Browse Source 
python/mypy#2380 showed a discrepancy between object and FunctionType in stdlib2. The first defined __doc__ to be str, the second Optional[str]. As FunctionType depends on object, this is no longer valid.

As suggested by @gvanrossum in python/mypy#2380, all __doc__ should be considered Optional.

(Final verdict was just to remove most __doc__ attributes since it's inherited from object.)
This commit is contained in:
TrueBrain
2016-10-30 19:48:23 +01:00
committed by Guido van Rossum
parent 1d47c6fdb8
commit 15ec66cdd6
14 changed files with 2 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
stdlib/2/optparse.pyi
View File

@@ -18,7 +18,6 @@ class OptParseError(Exception):
def __init__(self, msg) -> None: ...
class BadOptionError(OptParseError):
__doc__ = ... # type: str
opt_str = ... # type: Any
def __init__(self, opt_str) -> None: ...
@@ -65,7 +64,6 @@ class HelpFormatter:
def store_option_strings(self, parser) -> None: ...
class IndentedHelpFormatter(HelpFormatter):
__doc__ = ... # type: str
_long_opt_fmt = ... # type: str
_short_opt_fmt = ... # type: str
current_indent = ... # type: int
@@ -93,7 +91,6 @@ class Option:
TYPED_ACTIONS = ... # type: Tuple[str, ...]
TYPES = ... # type: Tuple[str, ...]
TYPE_CHECKER = ... # type: Dict[str, Callable]
__doc__ = ... # type: str
_long_opts = ... # type: List[Text]
_short_opts = ... # type: List[Text]
action = ... # type: str
@@ -162,7 +159,6 @@ class OptionGroup(OptionContainer):
def set_title(self, title) -> None: ...
class OptionParser(OptionContainer):
__doc__ = ... # type: str
_long_opt = ... # type: Dict[Text, Any]
_short_opt = ... # type: Dict[Any, Any]
allow_interspersed_args = ... # type: bool
@@ -220,11 +216,9 @@ class OptionParser(OptionContainer):
def set_usage(self, usage: Text) -> None: ...
class OptionValueError(OptParseError):
__doc__ = ... # type: str
msg = ... # type: Any
class TitledHelpFormatter(HelpFormatter):
__doc__ = ... # type: str
_long_opt_fmt = ... # type: str
_short_opt_fmt = ... # type: str
current_indent = ... # type: int