From aa3ade05b974d4897fdc9c652f38afdc4585edd8 Mon Sep 17 00:00:00 2001
From: Daniel Schadt <kingdread@gmx.de>
Date: Sun, 8 Dec 2019 16:12:43 +0100
Subject: add documentation for make_table.py

---
 make_table.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'make_table.py')

diff --git a/make_table.py b/make_table.py
index 18a30fa..9af49dd 100644
--- a/make_table.py
+++ b/make_table.py
@@ -1,3 +1,15 @@
+"""This script is used to downlaod the skill palette data.
+
+The Guild Wars 2 chat links for build templates use a different skill ID than
+the API, so skills need to be mapped from their "skill ID" to the corresponding
+"palette ID".
+
+Some game updates may require this mapping to be updated as well, otherwise the
+chat link parsing/generating functionality might be broken.
+
+To use this script, pipe the output to src/skill_palette.json and rebuild
+kondou.
+"""
 import requests
 import json
 from lxml import html, etree
-- 
cgit v1.2.3