aboutsummaryrefslogtreecommitdiffstats
path: root/includes/resourceloader/ResourceLoaderFileModule.php
diff options
context:
space:
mode:
authorAaron Schulz <aschulz@wikimedia.org>2019-03-10 12:56:34 -0700
committerKrinkle <krinklemail@gmail.com>2019-03-12 04:01:58 +0000
commitbc80791f4d840257e37dd72424784e3e28b8d651 (patch)
tree42c432963bd30fb783505d1681ace23c6fa8c1df /includes/resourceloader/ResourceLoaderFileModule.php
parent735dceaa45d2965508ffb6891a1049976f79310f (diff)
downloadmediawikicore-bc80791f4d840257e37dd72424784e3e28b8d651.tar.gz
mediawikicore-bc80791f4d840257e37dd72424784e3e28b8d651.zip
resourceloader: Reword and expand doc comment about FileModule "packageFiles"
Change-Id: Id9d68205504ecbddea6ca248e108f368fdcac2d2
Diffstat (limited to 'includes/resourceloader/ResourceLoaderFileModule.php')
-rw-r--r--includes/resourceloader/ResourceLoaderFileModule.php9
1 files changed, 5 insertions, 4 deletions
diff --git a/includes/resourceloader/ResourceLoaderFileModule.php b/includes/resourceloader/ResourceLoaderFileModule.php
index 28488712ddbf..9be5de3d6d4c 100644
--- a/includes/resourceloader/ResourceLoaderFileModule.php
+++ b/includes/resourceloader/ResourceLoaderFileModule.php
@@ -198,10 +198,11 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
* ],
* // Scripts to include in debug contexts
* 'debugScripts' => [file path string or array of file path strings],
- * // For package modules: files to make available for internal require() use
- * // 'type' is optional, and will be inferred from the file name extension if omitted
- * // 'config' can only be used when 'type' is 'data'; vars are resolved with Config::get()
- * // If 'packageFiles' is set, 'scripts' cannot also be set
+ * // For package modules: files to be made available for internal require() do not
+ * // need to have 'type' defined; it will be inferred from the file name extension
+ * // if omitted. 'config' can only be used when 'type' is 'data'; the variables are
+ * // resolved with Config::get(). The first entry in 'packageFiles' is always the
+ * // module entry point. If 'packageFiles' is set, 'scripts' cannot also be set.
* 'packageFiles' => [
* [file path string], // or:
* [ 'name' => [file name], 'file' => [file path], 'type' => 'script'|'data' ], // or: