click-contrib / click-man

Automate generation of man pages for python click applications :star:
MIT License
163 stars 35 forks source link

Missing docstring raises cryptic error #19

Closed smarlowucf closed 5 years ago

smarlowucf commented 6 years ago

When a docstring does not exist for a click group a few different errors are raised related to invalid processing of NoneType.

Example:

AttributeError: 'NoneType' object has no attribute 'split'

This isn't too hard to debug but would be nice to have an explicit exception when docstring is None.

CrispyDrone commented 5 years ago

Hi, I'm on a windows 7 installation using the latest python 2.7.15 version. I'm getting the AttributeError: 'NoneType' object has no attribute 'split' when i attempt the following command click-man mkdocs or click-man --target C:\Users\Me\Desktop\manpages mkdocs.

I've also tried running python setup.py --command-packages=click_man.commands man_pages which results in the following error AttributeError: Distribution instance has no attrribute 'entry_points'.

I investigated the setup.py file and this is its contents:

from distutils.core import setup

if __name__ == '__main__':
    setup(
      scripts=[
        'byteyears.py',
        'checkpyc.py',
        'copytime.py',
        'crlf.py',
        'dutree.py',
        'ftpmirror.py',
        'h2py.py',
        'lfcr.py',
        '../i18n/pygettext.py',
        'logmerge.py',
        '../../Lib/tabnanny.py',
        '../../Lib/timeit.py',
        'untabify.py',
        ],
      )

I tried defining entry_points but to no avail. Any help would be much appreciated!

smarlowucf commented 5 years ago

Started seeing this error with Click==7.0. All commands have descriptions == None even though the docstring is provided.