Formatting of description in function documentation
A lot of the functions documentation lacks the indent in the description section, for example binary_search
. This results in these functions being found and their help being displayed when just executing help function
:
isis> help function
where, since the where function is O(n), while binary_search
scales is O(lb(N)) where lb is the logarithm to base 2.
If no qualifiers are set, the function returns the index of the array
element if val is found. The function returns -1 if the value is not found.
If the interval qualifier is set, then the function will do an interval
search such that arr[ndx]<=value<arr[ndx]. The function will return
0 if value<=arr[0] and length(arr) if value>arr[-1]. This can be
used to search the index where one would insert a number into
an array.
isis>
This problem can be solved by either fixing all of the documentation or by maybe implementing the indent to be added when building the isisscripts.
Note: There are even functions supplied with S-Lang itself not having properly formatted documentation, for example is_substrbytes