Expand description
Documentation utilities.
Modules§
- tidy
- The documentation models for tidy.
Structs§
- DefInfo
- Information about a definition.
- DocString
- The documentation string of an item
- File
Meta - Information about a package.
- Package
DefInfo - Information about the definitions in a package.
- Package
Doc - Documentation Information about a package.
- Package
Meta - Information about a package.
- Package
Meta End - Information about a package.
- Param
DocsT - Describes a function parameter.
- Signature
DocsT - Describes a primary function signature.
- Tidy
Module Docs - A module documentation.
- Tidy
Param Docs - A parameter documentation.
- Tidy
PatDocs - A pattern documentation.
- VarDoc
- The documentation string of a variable associated with some item.
- VarDocsT
- Describes a primary pattern binding.
Enums§
- DefDocsT
- Documentation about a definition.
Functions§
- format_
ty - Formats the type.
- identify_
pat_ docs - Identifies the pattern documentation. For example,
#let (a, b) = x. - identify_
tidy_ module_ docs - Identifies the module documentation.
- module_
docs - Get documentation of definitions in a module.
- package_
docs - Generate full documents in markdown format
- package_
docs_ md - Generate full documents in markdown format
- package_
docs_ typ - Generate full documents in markdown format
- package_
module_ docs - Get documentation of definitions in a package.
- remove_
list_ annotations - Removes the list annotations from the string.
Type Aliases§
- DefDocs
- Documentation about a definition.
- Param
Docs - Documentation about a parameter.
- Signature
Docs - Documentation about a signature.
- Typeless
Param Docs - Documentation about a parameter (without type information).
- Untyped
DefDocs - Documentation about a definition (without type information).
- Untyped
Signature Docs - Documentation about a signature.
- Untyped
VarDocs - Documentation about a variable (without type information).
- VarDocs
- Documentation about a variable.