Skip to content

Commit

Permalink
docs: fix typo in last "how it works" paragraph
Browse files Browse the repository at this point in the history
  • Loading branch information
cpcloud committed Nov 24, 2021
1 parent 74b5648 commit 3f8efde
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -58,16 +58,16 @@ The `out/thing1_pb2.py` file should show a diff containing at least these lines:

## How it works

At a high level, `protoletariat` converts absolute imports to relative imports.
At a high level `protoletariat` converts absolute imports to relative imports.

However, it doesn't just convert any absolute import to a relative import.
However, it doesn't convert just any absolute import to a relative import.

The `protol` tool will only convert imports that were generated from `.proto` files. It
does this by inspecting `FileDescriptorProtos` from the protobuf files.

The core mechanism is implemented using a simplified form of pattern matching,
that looks at the Python AST, and if an import pattern is matched and
corresponding rewrite rule is fired.
The core rewrite mechanism is implemented using a simplified form of pattern
matching, that looks at the Python AST, and if an import pattern is matched a
corresponding rewrite rule is invoked.

## Help

Expand Down

0 comments on commit 3f8efde

Please sign in to comment.