Skip to content

Commit

Permalink
Update usage doc comments for some tools/*.py scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
Rangi42 committed Sep 2, 2021
1 parent 0217026 commit 868e28f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
8 changes: 8 additions & 0 deletions tools/palfix.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion tools/sym_comments.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
1 change: 1 addition & 0 deletions tools/toc.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 868e28f

Please sign in to comment.