From 868e28f309ec8d08bcdea913c3fc53b0ef55315f Mon Sep 17 00:00:00 2001
From: Rangi <remy.oukaour+rangi42@gmail.com>
Date: Thu, 2 Sep 2021 18:48:17 -0400
Subject: [PATCH] Update usage doc comments for some tools/*.py scripts

---
 tools/palfix.py       | 8 ++++++++
 tools/sym_comments.py | 2 +-
 tools/toc.py          | 1 +
 3 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/tools/palfix.py b/tools/palfix.py
index 20c9ef29c..8d53d35e7 100755
--- a/tools/palfix.py
+++ b/tools/palfix.py
@@ -1,6 +1,14 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Usage: python palfix.py image.png
+
+Fix the palette format of the input image. Colored images (Pokémon or trainer
+sprites) will become indexed, with a palette sorted {white, light color, dark
+color, black}. Grayscale images will become two-bit grayscale.
+"""
+
 from __future__ import print_function
 
 import sys
diff --git a/tools/sym_comments.py b/tools/sym_comments.py
index b26a81b7f..27d37ca23 100755
--- a/tools/sym_comments.py
+++ b/tools/sym_comments.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Usage: ./sym_comments.py file.asm [pokecrystal.sym] > file_commented.asm
+Usage: python3 sym_comments.py file.asm [pokecrystal.sym] > file_commented.asm
 
 Comments each label in file.asm with its bank:address from the sym file.
 """
diff --git a/tools/toc.py b/tools/toc.py
index 13b75ae1c..e3d719edf 100755
--- a/tools/toc.py
+++ b/tools/toc.py
@@ -3,6 +3,7 @@
 
 """
 Usage: python3 toc.py [-n] files.md...
+
 Replace a "## TOC" heading in a Markdown file with a table of contents,
 generated from the other headings in the file. Supports multiple files.
 Headings must start with "##" signs to be detected.