Skip to content
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

argparse.ArgumentParser must have description #1034

Closed
orsinium opened this issue Nov 27, 2019 · 1 comment
Closed

argparse.ArgumentParser must have description #1034

orsinium opened this issue Nov 27, 2019 · 1 comment
Labels
rule request Adding a new rule

Comments

@orsinium
Copy link
Collaborator

Rule request

Thesis

# bad
parser = ArgumentParser()
# good
parser = ArgumentParser(description="do magic")

Reasoning

flake8-docstrings enforces docstrings for everything that part of your public interface. CLI is definitely the most important part of the API, and it should have a good description as well.

@orsinium orsinium added the rule request Adding a new rule label Nov 27, 2019
@sobolevn
Copy link
Member

sobolevn commented Nov 30, 2019

Well, I guess it is too-specific. And it would be hard to check that we cover all possible ArgumentParser use-cases. Maybe some flake8-argparse would be a better place for this rule?

Thanks for raising this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rule request Adding a new rule
Projects
None yet
Development

No branches or pull requests

2 participants