resourceloader: Reword and expand doc comment about FileModule "packageFiles"
authorAaron Schulz <aschulz@wikimedia.org>
Sun, 10 Mar 2019 19:56:34 +0000 (12:56 -0700)
committerKrinkle <krinklemail@gmail.com>
Tue, 12 Mar 2019 04:01:58 +0000 (04:01 +0000)
Change-Id: Id9d68205504ecbddea6ca248e108f368fdcac2d2

includes/resourceloader/ResourceLoaderFileModule.php

index 2848871..9be5de3 100644 (file)
@@ -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: