Skip to content

Instantly share code, notes, and snippets.

@kelvintaywl

kelvintaywl/test.rst

Last active February 28, 2018 04:01
Show Gist options
  • Save kelvintaywl/345daec1003528ca7a4dad2372a4c341 to your computer and use it in GitHub Desktop.
Save kelvintaywl/345daec1003528ca7a4dad2372a4c341 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
test.rst

PulpFiction

./images/jules.png

English, ****! Do you speak it?*

A simple tool to detect non-English commments in a code base (directory).

Inspired by the fictional character, Jules Winnfield, played by Samuel L Jackson in the film, Pulp Fiction.

Install

` pip install pulpfiction `

Usage

``` jules --help

Usage: jules [OPTIONS]

Simple tool to detect non-English commments in a code base..
Options:
--path TEXT path to project or repository
--help Show this message and exit.

```

` # Alternatively, jules --path=~/personal/my-awesome-git-project `

Script exits with sys.exit(0) if successful, else the earliest invalid comment is found and raised.

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