From 5eccb0ed49b4cfa89ea0ac73e6fefa6324bd530e Mon Sep 17 00:00:00 2001
From: black-sliver <59490463+black-sliver@users.noreply.github.com>
Date: Wed, 23 Mar 2022 02:22:58 +0100
Subject: [PATCH] api.md: clarify get_required_client_version (#334)

---
 docs/api.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/api.md b/docs/api.md
index d77c3bad..e5ae85e7 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -408,6 +408,8 @@ In addition the following methods can be implemented
 * `def get_required_client_version(self)`
   can return a tuple of 3 ints to make sure the client is compatible to this
   world (e.g. item IDs) when connecting.
+  Always use `return max((x,y,z), super().get_required_client_version())`
+  to catch updates in the lower layers that break compatibility.
 
 #### generate_early