Fill out missing docstrings

[fhammerschmidt]

The new Stdlib still has quite a few modules that are not fully documented.
Also some of them lack .resi files. They should be documented fully in the .resi, not .res file.

• Stdlib (does this not need a .resi as well?)
  • globalThis
  • panic
  • null
  • undefined
  • typeof
• Stdlib_Array
  • fromArrayLike
  • fromArrayLikeWithMap
  • equal
  • compare
  • isArray
  • copyAllWithin
  • copyWithinToEnd
  • copyWithin (can't we consolidate these three to one with optional params ?)
  • splice
  • toSpliced
  • with
  • indexOfFrom
  • toLocaleString
  • getSymbol
  • getSymbolUnsafe
  • setSymbol
• Stdlib_ArrayBuffer
  • missing .resi
  • make
  • byteLength
  • slice
  • sliceToEnd
• Stdlib_BigInt
  • missing .resi
  • asIntN
  • asUintN
  • fromInt
  • fromFloat
  • toFloat
  • toInt
  • add, sub, mul, div, mod, bitwiseAnd, bitwiseOr, bitwiseXor, bitwiseNot, shiftLeft, shiftRight
• Stdlib_BigInt64Array
  • missing .resi
• Stdlib_BigUint64Array
  • missing .resi
• Stdlib_Bool
  • compare
  • equal
• Stdlib_DataView
  • missing .resi
  • basically everything in there
• Stdlib_Date
  • equal
  • compare
• Stdlib_Float
  • equal
  • compare
• Stdlib_Float32Array
  • missing .resi
• Stdlib_Float64Array
  • missing .resi
• Stdlib_Int16Array
  • missing .resi
• Stdlib_Int32Array
  • missing .resi
• Stdlib_Int8Array
  • missing .resi
• Stdlib_Intl_Collator
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • compare
• Stdlib_Intl_Common
  • missing .resi
• Stdlib_Intl_DateTimeFormat
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • format
  • formatToParts
  • formatRangeToParts
• Stdlib_Intl_ListFormat
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • format
  • formatToParts
• Stdlib_Intl_Locale
  • missing .resi
  • basicallly everything
• Stdlib_Intl_NumberFormat_Grouping
  • missing .resi
  • fromBool
  • fromString
  • parseJsValue
• Stdlib_Intl_NumberFormat
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • format
  • formatRange
  • formatToParts
  • formatRangeToParts
  • formatInt
  • formatIntRange
  • formatIntToParts
  • formatIntRangeToParts
  • formatBigInt
  • formatBigIntRange
  • formatBigIntToParts
  • formatBigIntRangeToParts
  • formatString
  • formatStringToParts
• Stdlib_Intl_PluralRules
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • select
  • selectInt
  • selectBigInt
  • selectRange
  • selectRangeInt
  • selectRangeBigInt
• Stdlib_Intl_RelativeTimeFormat
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • format
  • formatToParts
• Stdlib_Intl_Segmenter
  • missing .resi
  • make
  • supportedLocalesOf
  • resolvedOptions
  • segment
• Stdlib_Intl_Segments
  • missing .resi
  • containing
  • containingWithIndex
• Stdlib_Intl
  • missing .resi
  • basically everything
• Stdlib_Null
  • equal
  • compare
• Stdlib_Nullable
  • equal
  • compare
• Stdlib_Object
  • missing .resi
  • copy
  • getSymbolUnsafe
  • setSymbol
• Stdlib_Option
• Stdlib_Ordering
  • missing .resi
  • basically everything
• Stdlib_Pair
  • missing .resi
• Stdlib_String
  • equal
  • compare
  • getSymbol
  • getSymbolUnsafe
  • setSymbol
• Stdlib_Symbol
  • asyncIterator
  • hasInstance
  • isConcatSpreadable
  • iterator
  • match
  • matchAll
  • replace
  • search
  • species
  • split
  • toPrimitive
  • toStringTag
  • unscopables
• Stdlib_TypedArray
  • missing .resi
  • basically everything
• Stdlib_Uint16Array
  • missing .resi
• Stdlib_Uint32Array
  • missing .resi
• Stdlib_Uint8Array
  • missing .resi
• Stdlib_Uint8ClampedArray
  • missing .resi
• Stdlib_WeakMap
  • missing .resi
  • basically everything
• Stdlib_WeakSet
  • missing .resi
  • basically everything

[cknitt]

Are missing .resi files really an issue? If the module consists only of bindings, then everything is just duplicated from .res to .resi.

In such cases, why not keep only .res and put the docstrings into the .res?

[nojaf]

Will .res files also have their examples run in the test?

[cknitt]

Will .res files also have their examples run in the test?

Doc extraction logic extracts from .res if there is no .resi:

rescript/tests/docstring_tests/DocTest.res

Line 251 in b9e2059

| f if f->String.endsWith(".res") && !(files->Array.includes(f ++ "i")) => true