openstack/pbr
Code Issues Proposed changes

Add docstring from LocalManifestMaker.add_defaults

Browse Source 
A not-so-recent change to setuptools [1] has resulted in the inclusion
of a docstring from distutils that uses broken rST.

  docstring of pbr.packaging.LocalManifestMaker.add_defaults:11:Definition
  list ends without a blank line; unexpected unindent.

Resolve the issue by simply redefining the docstring.

[1] 252ee6f...f1cf491f
[2] https://github.com/python/cpython/blob/3.4/Lib/distutils/command/sdist.py#L217-L229

Change-Id: I84b5097bc31af601061a77dfea9d6a6f38b018cc
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane 2018-07-05 15:27:09 +01:00
parent 73234c84b5
commit 3dc5ae566b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pbr/packaging.py
View File

@ -488,6 +488,15 @@ class LocalManifestMaker(egg_info.manifest_maker):
self.filelist.process_template_line(template_line) self.filelist.process_template_line(template_line)
def add_defaults(self): def add_defaults(self):
"""Add all the default files to self.filelist:
Extends the functionality provided by distutils to also included
additional sane defaults, such as the ``AUTHORS`` and ``ChangeLog``
files generated by *pbr*.
Warns if (``README`` or ``README.txt``) or ``setup.py`` are missing;
everything else is optional.
"""
option_dict = self.distribution.get_option_dict('pbr') option_dict = self.distribution.get_option_dict('pbr')
sdist.sdist.add_defaults(self) sdist.sdist.add_defaults(self)