pulpfiction 0.3.0

*****
低俗小说
*****

.. image:: ./images/jules.png

*英语，*****！你会说吗？*

一个检测代码库（目录）中非英语评论的简单工具。

受到塞缪尔·杰克逊在电影《低俗小说》中扮演的虚构人物“朱尔斯·温菲尔德”的启发。

.. __: https://www.urbandictionary.com/define.php?term=Jules%20Winnfield

安装
#######

.. code-block:: bash

# 需要 Python3
$ pip install pinchfiction

用法
### ##

.. code-block:: bash

$ jules --help

用法： jules [OPTIONS]

检测代码库中非英语注释的简单工具..

选项：
--path 项目或存储库的文本路径
--help 显示此消息并退出。


.. code-block:: bash

# 默认情况下，它会查看当前目录或 $PWD
# 或者
$ jules --path=~/personal/my-awesome-git-project


脚本以 `sys.exit(0 )` 如果成功，则找到并提出最早的无效评论。

已知问题
############

- 注释掉的代码将被视为非英语；假阳性。