New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support requirements in docstring #31

Closed
ralsina opened this Issue Feb 12, 2015 · 4 comments

Comments

Projects
None yet
3 participants
@ralsina

ralsina commented Feb 12, 2015

It would be nice if, in addition to comments on imports, you could support a requirements.txt-like thing in the script's docstring, like this:

#!/usr/bin/python

"""
This script to foobar the bazbats has the following requirements:

foo >=1.0
bar <2
bat
baz
"""

Syntax, parsing, etc are left as exercise for the authors ;-)

@facundobatista

This comment has been minimized.

Show comment
Hide comment
@facundobatista

facundobatista Feb 12, 2015

Member

I would include a "fades flag", that would be a line with the fades word, and then indentation, like...

"""Script superpoderoso.

Requirements for fades:
    foo >= 1.0
    bar
"""
Member

facundobatista commented Feb 12, 2015

I would include a "fades flag", that would be a line with the fades word, and then indentation, like...

"""Script superpoderoso.

Requirements for fades:
    foo >= 1.0
    bar
"""

@facundobatista facundobatista modified the milestone: Release 3 Feb 13, 2015

@facundobatista

This comment has been minimized.

Show comment
Hide comment
@facundobatista

facundobatista May 3, 2015

Member

I'd postpone this from Release 3...

Member

facundobatista commented May 3, 2015

I'd postpone this from Release 3...

@gilgamezh

This comment has been minimized.

Show comment
Hide comment
@gilgamezh

gilgamezh May 3, 2015

Contributor

I'd postpone this from Release 3...

👍

Contributor

gilgamezh commented May 3, 2015

I'd postpone this from Release 3...

👍

@gilgamezh gilgamezh modified the milestones: Cool release, Release 3 May 4, 2015

@gilgamezh gilgamezh modified the milestones: Cool release, Release 5 Jun 29, 2015

@facundobatista

This comment has been minimized.

Show comment
Hide comment
@facundobatista

facundobatista Sep 1, 2015

Member

This was just closed by #111.

Member

facundobatista commented Sep 1, 2015

This was just closed by #111.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment