Skip to content

Commit

Permalink
update package and version module docstrings
Browse files Browse the repository at this point in the history
Co-authored-by: gnbl <gnbl@github>
  • Loading branch information
hugovk and gnbl committed Jul 1, 2018
1 parent 500aa9f commit 36be37c
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions src/PIL/__init__.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
#
# The Python Imaging Library.
# $Id$
#
# package placeholder
#
# Copyright (c) 1999 by Secret Labs AB.
#
# See the README file for information on usage and redistribution.
#
"""Pillow {} (Fork of the Python Imaging Library)
# ;-)
Pillow is the friendly PIL fork by Alex Clark and Contributors.
https://github.com/python-pillow/Pillow/
Pillow is forked from PIL 1.1.7.
PIL is the Python Imaging Library by Fredrik Lundh and Contributors.
Copyright (c) 1999 by Secret Labs AB.
Use PIL.__version__ for this Pillow version.
PIL.VERSION is the old PIL version and will be removed in the future.
;-)
"""

from . import _version

Expand All @@ -21,6 +24,9 @@

del _version

__doc__ = __doc__.format(__version__) # include version in docstring


_plugins = ['BlpImagePlugin',
'BmpImagePlugin',
'BufrStubImagePlugin',
Expand Down

2 comments on commit 36be37c

@Menollo
Copy link

@Menollo Menollo commented on 36be37c Jul 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change breaks running Pillow with PYTHONOPTIMIZE=2 because that strips the _ _ doc _ _ variable: import PIL gives the Exception: AttributeError: 'NoneType' object has no attribute 'format' (because of line 27)

@hugovk
Copy link
Member Author

@hugovk hugovk commented on 36be37c Jul 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please # to comment.