Skip to content

Commit 33cb777

Browse files
committed
Update import/export docs to mention array('custom', 'key') format
1 parent 8ab95a4 commit 33cb777

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/main/java/com/laytonsmith/core/functions/DataHandling.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2717,12 +2717,11 @@ public Integer[] numArgs() {
27172717

27182718
@Override
27192719
public String docs() {
2720-
return "mixed {key, [default]} This function imports a value from the global value"
2721-
+ " register. It looks for a value stored with the specified key, and"
2722-
+ " returns that value. Items can be stored with the export function."
2723-
+ " If the specified string key doesn't exist, null is returned. However, if a"
2724-
+ " second argument is provided, it will return that instead of null."
2725-
+ " import() is threadsafe.";
2720+
return "mixed {key, [default]} This function imports a value from the global value register. It looks for a"
2721+
+ " value stored with the specified key (using the export function), and returns that value."
2722+
+ " If specified key doesn't exist, it will return either null or the default value if specified."
2723+
+ " An array may be used as a key. It is converted into a string with the array values separated by"
2724+
+ " dots. import() is threadsafe.";
27262725
}
27272726

27282727
@Override
@@ -2789,7 +2788,8 @@ public String docs() {
27892788
+ " An arbitrary value is stored with the given key, and can be retreived using import."
27902789
+ " If the value is already stored, it is overwritten. See {{function|import}}."
27912790
+ " The reference to the value is stored, not a copy of the value, so in the case of"
2792-
+ " arrays, manipulating the contents of the array will manipulate the stored value."
2791+
+ " arrays, manipulating the contents of the array will manipulate the stored value. An array may"
2792+
+ " be used as a key. It is converted into a string with the array values separated by dots."
27932793
+ " export() is threadsafe.";
27942794
}
27952795

0 commit comments

Comments
 (0)