From 73d56819269eeb730fb99373f482513f75aeb1b9 Mon Sep 17 00:00:00 2001
From: Kenzie Togami <ket1999@gmail.com>
Date: Sat, 20 Apr 2019 23:36:44 -0700
Subject: [PATCH] Add a note about which libraries get shaded where

---
 worldedit-libs/build.gradle | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/worldedit-libs/build.gradle b/worldedit-libs/build.gradle
index 983d2dc41..81d44c28c 100644
--- a/worldedit-libs/build.gradle
+++ b/worldedit-libs/build.gradle
@@ -1,5 +1,17 @@
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+/*
 
+This project shades <em>API</em> libraries, i.e. those libraries
+whose classes are publicly referenced from `-core` classes.
+
+This project <em>does not</em> shade implementation libraries, i.e.
+those libraries whose classes are internally depended on.
+
+This is because the main reason for shading those libraries is for
+their internal usage in each platform, not because we need them available to
+dependents of `-core` to compile and work with WorldEdit's API.
+
+ */
 subprojects {
     apply plugin: 'maven'
     apply plugin: 'com.github.johnrengelman.shadow'