API:Class/RbxLibrary/Help

Help

Warning: When calling this function, you should use a . to index it, rather than a :
Function of Object Icon.pngRbxLibrary
string Help (
    Variant<string, function> funcNameOrFunc
)
Parameters:
  1. funcNameOrFunc

Returns: string
Description: Returns a string, representing the documentation of a function in the library, which can be printed into the output.

funcNameOrFunc should be either the name of a function, as a string, or the indexed function itself.

Example

Using the name of a function to print its documentation.

local RbxGui = LoadLibrary("RbxGui")
print(RbxGui.Help("CreatePropertyDropDownMenu"))
Function CreateDropDownMenu.  
Arguments: (items, onItemSelected).  
Side effect: Returns 2 results, a container to the gui object and a 
'updateSelection' function for external updating.  The container is a 
drop-down-box created around a list of items

Using the function itself to print its documentation.

local RbxGui = LoadLibrary("RbxGui")
print(RbxGui.Help(RbxGui.CreatePropertyDropDownMenu))
Function CreateDropDownMenu.  
Arguments: (items, onItemSelected).  
Side effect: Returns 2 results, a container to the gui object and a 
'updateSelection' function for external updating.  The container is a 
drop-down-box created around a list of items