Ensure built-in functions are sorted before being documented

Author: HugoGGuerrier

lkql_jit/language/src/main/java/com/adacore/lkql_jit/built_ins/BuiltInFunctions.java

@@ -41,7 +41,9 @@
 import java.io.StringWriter;
 import java.util.Arrays;
 import java.util.Comparator;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 /**
  * Module where most of the LKQL built-in functions are declared. General purpose built-in functions
@@ -192,7 +194,11 @@ public static String exec() {
                 writer.write("^^^^^^^^^^^^^^^^^\n");
                 writer.write("\n");
 
-                for (var func : AllBuiltIns.allFunctions()) {
+                List<BuiltInFunctionValue> sortedBuiltinFunctions = AllBuiltIns.allFunctions()
+                    .stream()
+                    .sorted((l, r) -> l.getExecutableName().compareTo(r.getExecutableName()))
+                    .collect(Collectors.toList());
+                for (var func : sortedBuiltinFunctions) {
                     writer.write(".. function:: ");
                     writer.write(func.getExecutableName());
                     writer.write("(" + String.join(", ", func.parameterNames) + ")");

user_manual/generated/std.rst

@@ -4,78 +4,78 @@ Standard library
 Builtin functions
 ^^^^^^^^^^^^^^^^^
 
-.. function:: unique(indexable)
-
-    Given a collection, create a list with all duplicates removed
-
-.. function:: pattern(regex, case_sensitive)
-
-    Given a regex pattern string, create a pattern object
-
-.. function:: print(to_print, new_line)
+.. function:: base_name(file_name)
 
-    Built-in print function. Prints the argument
+    Given a string that represents a file name, returns the basename
 
-.. function:: img(string)
+.. function:: concat(list)
 
-    Return a string representation of an object
+    Given a list, return the result of the concatenation of all its elements
 
 .. function:: doc(value)
 
     Given any object, return the documentation associated with it
 
-.. function:: reduce(iterable, function, init_value)
-
-    Given a collection, a reduction function, and an initial value reduce the result
-
 .. function:: document_builtins()
 
     Return a string in the RsT format containing documentation for all built-ins
 
-.. function:: base_name(file_name)
+.. function:: document_namespace(namespace, name)
 
-    Given a string that represents a file name, returns the basename
+    Return a string in the RsT format containing documentation for all built-ins
 
-.. function:: concat(list)
+.. function:: help(value)
 
-    Given a list, return the result of the concatenation of all its elements
+    Print formatted help for the given object
 
-.. function:: repeat(times, function)
+.. function:: img(string)
 
-    Call the given function N times
+    Return a string representation of an object
 
 .. function:: map(iterable, function)
 
     Given a collection, a mapping function
 
-.. function:: profile(val)
+.. function:: node_checker(root)
 
-    Given any object, if it is a callable, return its profile as text
+    Given a root, execute all node checkers while traversing the tree
 
-.. function:: document_namespace(namespace, name)
+.. function:: pattern(regex, case_sensitive)
 
-    Return a string in the RsT format containing documentation for all built-ins
+    Given a regex pattern string, create a pattern object
 
-.. function:: help(value)
+.. function:: print(to_print, new_line)
 
-    Print formatted help for the given object
+    Built-in print function. Prints the argument
 
-.. function:: units()
+.. function:: profile(val)
 
-    Return a list of all units
+    Given any object, if it is a callable, return its profile as text
+
+.. function:: reduce(iterable, function, init_value)
+
+    Given a collection, a reduction function, and an initial value reduce the result
+
+.. function:: repeat(times, function)
+
+    Call the given function N times
 
 .. function:: specified_units()
 
     Return a list of units specified by the user
 
-.. function:: node_checker(root)
+.. function:: unique(indexable)
 
-    Given a root, execute all node checkers while traversing the tree
+    Given a collection, create a list with all duplicates removed
 
 .. function:: unit_checker(unit)
 
     Given a unit, apply all the unit checkers on it
 
+.. function:: units()
+
+    Return a list of all units
+
 Builtin methods
 ^^^^^^^^^^^^^^^