weixin_39683863
weixin_39683863
2020-11-24 12:47

user manual

It would be really nice to have a user manual.

该提问来源于开源项目:PyCQA/pyflakes

  • 点赞
  • 写回答
  • 关注问题
  • 收藏
  • 复制链接分享
  • 邀请回答

5条回答

  • weixin_39831902 weixin_39831902 5月前

    Here's why pyflakes doesn't have much of a manual:

    image https://xkcd.com/1343/

    Are there really no other options?

    What options would you want?

    What types of checks does pyflakes do?

    See messages.py or see the tests for code examples.

    Is there any mechanism for disabling any specific checks that one might not want?

    No. According to the design principles in the README, pyflakes "will never complain about style, and it will try very, very hard to never emit false positives." So if pyflakes was emitting errors that people often wanted to disable, this would be a design flaw in pyflakes.

    Are there some checks you want to disable?

    Reading from stdin in the absence of options is a fairly common thing for a command-line program to do. For example, wc, cat, sort, uniq, awk, sed, cut, and tar. If you'd like, documenting this behavior in the --help output would be a welcome PR.

    点赞 评论 复制链接分享
  • weixin_39958112 weixin_39958112 5月前

    Surely the --help output could actually include a description.

    点赞 评论 复制链接分享
  • weixin_39955149 weixin_39955149 5月前

    Just curious, what would you like that's more than the current README or the output of pyflakes --help?

    点赞 评论 复制链接分享
  • weixin_39683863 weixin_39683863 5月前

    Hello Anthony,

    I made the mistake of typing pyflakes without any options, and it simply sat there doing nothing until I killed it off.

    When I run pyflakes --help, here's what I see:

    Usage: pyflakes-script.py [options]

    Options: --version show program's version number and exit -h, --help show this help message and exit

    Are there really no other options? What types of checks does pyflakes do? Is there any mechanism for disabling any specific checks that one might not want?

    Phillip

    On Mon, Nov 25, 2019 at 2:06 PM Anthony Sottile wrote:

    Just curious, what would you like that's more than the current README https://github.com/pycqa/pyflakes or the output of pyflakes --help?

    — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/PyCQA/pyflakes/issues/492?email_source=notifications&email_token=AAIEDRCPH5CIHFXK5KXMZ4TQVREAHA5CNFSM4JRPJGXKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFD6XEA#issuecomment-558361488, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIEDRF462J36YXYCWI7WE3QVREAHANCNFSM4JRPJGXA .

    点赞 评论 复制链接分享
  • weixin_39955149 weixin_39955149 5月前

    with no arguments it reads from stdin (mostly, I think, for editor configuration)

    It indeed doesn't have any options or ways to disable checks -- you probably want flake8 if you want those features

    点赞 评论 复制链接分享

相关推荐