Skip to content

Commit f93339e

Browse files
committed
add dialects module docstring
1 parent 0689ade commit f93339e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

unpythonic/dialects/__init__.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
11
# -*- coding: utf-8 -*-
2+
"""Dialects: Python the way you want it.
3+
4+
These dialects, i.e. whole-module syntax transformations, are powered by
5+
`mcpyrate`'s dialect subsystem. The user manual is at:
6+
https://github.com/Technologicat/mcpyrate/blob/master/doc/dialects.md
7+
8+
We provide these dialects mainly to demonstrate how to use that subsystem
9+
to customize Python beyond what a local macro expander can do.
10+
11+
For examples of how to use the dialects, see the unit tests.
12+
"""
213

314
# re-exports
415
from .lispython import Lispython # noqa: F401

0 commit comments

Comments
 (0)