User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

cl:functions:inspect [2019/07/14 17:00]
cl:functions:inspect [2019/07/20 08:00] (current)
Line 1: Line 1:
 +====== Function INSPECT ======
 +
 +====Syntax====
 +  * **inspect** //object// → ////​[[CL:​Glossary:​implementation-dependent]]////​
 +
 +====Arguments and Values====
 +  * //object// - an //​[[CL:​Glossary:​object]]//​.
 +
 +====Description====
 +**inspect** is an interactive version of **[[CL:​Functions:​describe]]**. The nature of the interaction is //​[[CL:​Glossary:​implementation-dependent]]//,​ but the purpose of **inspect** is to make it easy to wander through a data structure, examining and modifying parts of it.
 +
 +====Examples====
 +None.
 +
 +====Side Effects====
 +//​[[CL:​Glossary:​implementation-dependent]]//​.
 +
 +====Affected By====
 +//​[[CL:​Glossary:​implementation-dependent]]//​.
 +
 +====Exceptional Situations====
 +//​[[CL:​Glossary:​implementation-dependent]]//​.
 +
 +====See Also====
 +**[[CL:​Functions:​describe|Function DESCRIBE]]**
 +
 +====Notes====
 +Implementations are encouraged to respond to the typing of ''?''​ or a "help key" by providing help, including a list of commands.
 +
 +\issue{RETURN-VALUES-UNSPECIFIED:​SPECIFY}