search

mozilla / active-data-recipes

A repository of various activedata queries and recipes
Mozilla Public License 2.0
8 stars 24 forks source link

If recipe doesnt have docstring error is thrown but doesnt explain why #139

Open AutomatedTester opened 5 years ago

AutomatedTester commented 5 years ago

I created a new recipe .py and when I ran it I got an error throw but didnt explain what I did wrong

(data) davidburns in ~/development/mochivswpt-recipes(ruby-2.6.0) λ adr mochivswpt         
Traceback (most recent call last):
  File "/Users/davidburns/.virtualenvs/data/bin/adr", line 10, in <module>
    sys.exit(main())
  File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/cli.py", line 227, in main
    result = handler(remainder)
  File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/cli.py", line 180, in handle_recipe
    data = run_recipe(config.recipe, remainder)
  File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/recipe.py", line 83, in run_recipe
    doc = get_docstring(recipe, fmt="text")
  File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/recipe.py", line 117, in get_docstring
    lines = doc.splitlines()
AttributeError: 'NoneType' object has no attribute 'splitlines'
ahal commented 5 years ago

Thanks for filing! There's a ./doclint binary that tests for missing docstrings when running tox. But we shouldn't assume that docstrings are necessary.

On Thu, Aug 22, 2019 at 9:24 AM David Burns notifications@github.com wrote:

I created a new recipe .py and when I ran it I got an error throw but didnt explain what I did wrong

(data) davidburns in ~/development/mochivswpt-recipes(ruby-2.6.0) λ adr mochivswpt

Traceback (most recent call last):

File "/Users/davidburns/.virtualenvs/data/bin/adr", line 10, in 

sys.exit(main())

File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/cli.py", line 227, in main

result = handler(remainder)

File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/cli.py", line 180, in handle_recipe

data = run_recipe(config.recipe, remainder)

File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/recipe.py", line 83, in run_recipe

doc = get_docstring(recipe, fmt="text")

File "/Users/davidburns/.virtualenvs/data/lib/python3.7/site-packages/adr/recipe.py", line 117, in get_docstring

lines = doc.splitlines()

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

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/mozilla/active-data-recipes/issues/139?email_source=notifications&email_token=AACC2RSASX4ORVN2PCBNM43QF2HQTA5CNFSM4IOU65U2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HGZEVQQ, or mute the thread https://github.com/notifications/unsubscribe-auth/AACC2RQ3VM5DDMQFP4KP2D3QF2HQTANCNFSM4IOU65UQ .