Fix check_comment_ascii.py

2025-11-14 11:45:32 +08:00 · 2025-11-14 11:45:32 +08:00 · 1d4d67daf8
commit 1d4d67daf8
parent 7538e218a5
1 changed files with 11 additions and 0 deletions
--- a/check_comment_ascii.py
+++ b/check_comment_ascii.py
@ -1,4 +1,15 @@
 #!/usr/bin/env python3
+
+"""
+Check whether given python files contain non-ASCII comments.
+
+How to check the whole git repo:
+
+```
+$ git ls-files -z -- '*.py' | xargs -0 python3 check_comment_ascii.py
+```
+"""
+
 import sys
 import tokenize
 import ast