Skip to content

About ​

What the system knows about a name, as a dictionary.

About(x)compute-engine's entries, and the manifest's for a head not declared yet or a namespaced name
Typed signatures
TypePackageApplies
(any) -> dictionary<any>compute-enginealways
(any) -> dictionary<any>evaluationreplaces compute-enginealways

Domain: Compute engine

Details

A name is given as a symbol, About(Zeta), or qualified, About(ada.Sq). A string is a value, as compute-engine has it: About("Sin") describes the string. Any other expression is described by its kind and type.

compute-engine's keys come first: name, kind, signature or type, description, examples (its definition's own), keywords, attributes, wikidata, url. Ours follow:

  • overloads, every package's, most specific first; params, defaults, documented (the packages whose records document it) and findstat;
  • for a library symbol, namespace, pin, requires and head (the head it's declared as).

A head no package has declared yet is described from the manifest: its kind and signature are the ones it will have once declared, the overload no other replaces. A namespaced name is described from its library's index, and never declared to answer.

Examples

Basic #

A native head, as compute-engine describes it

live ↗
InAbout(sin⁡)[description]\mathrm{About}(\sin)[\text{description}]OutSine of an angle.\text{Sine of an angle.}

One of ours, with the packages that document it

live ↗
InAbout(MajorIndex)[documented]\mathrm{About}(\mathrm{MajorIndex})[\text{documented}]Out[combinatorics]\bigl\lbrack\text{combinatorics}\bigr\rbrack

Every package's overload of Floor, whether or not they are declared

live ↗
InCount(About(Floor)[overloads])\mathrm{Count}(\mathrm{About}(\mathrm{Floor})[\text{overloads}])Out33

The signature Floor is declared with once every package is in: the overload no other replaces

live ↗
InAbout(Floor)[signature]\mathrm{About}(\mathrm{Floor})[\text{signature}]Out(any, any?) -> any\text{(any, any?) -> any}

A namespaced name is described, never declared

live ↗
InAbout(Field(Combinatorics,MajorIndex))[namespace]\mathrm{About}(\mathrm{Field}(\mathrm{Combinatorics}, \text{MajorIndex}))[\text{namespace}]OutCombinatorics\text{Combinatorics}
About
Examples5

Implementation

mappedwolframpackages/oracle/src/mappings.ts

Wolfram has no About; Information[Sin] is the nearest, and gives an InformationData object with its own keys (Usage, Attributes, Documentation), not a dictionary of these. A part of it isn't a part of About's.

See also: Head