From 1d4d67daf846f10e624677df5deb59b2b044736b Mon Sep 17 00:00:00 2001
From: Zhichang Yu <yuzhichang@gmail.com>
Date: Fri, 14 Nov 2025 11:45:32 +0800
Subject: [PATCH] Fix check_comment_ascii.py

---
 check_comment_ascii.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/check_comment_ascii.py b/check_comment_ascii.py
index 98bc9c2e3..57d188b6c 100644
--- 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