Current section

Files

Jump to
magma docs.magma artefacts final modules Mix Tasks Magma Text Finalize ModuleDoc of Mix.Tasks.Magma.Text.Finalize.md
Raw

docs.magma/artefacts/final/modules/Mix/Tasks/Magma/Text/Finalize/ModuleDoc of Mix.Tasks.Magma.Text.Finalize.md

---
magma_type: Artefact.Version
magma_artefact: ModuleDoc
magma_concept: "[[Mix.Tasks.Magma.Text.Finalize]]"
magma_draft: "[[Generated ModuleDoc of Mix.Tasks.Magma.Text.Finalize (2023-11-02T21:30:34)]]"
created_at: 2023-11-02 21:31:39
tags: [magma-vault]
aliases: []
---
>[!caution]
>Ensure that the module documentation is under a "Moduledoc" section, as the contents of this section is used for the `@moduledoc`.
>
>Note, that the function docs are not used automatically. They are just suggestions for improvements and must be applied manually.
# ModuleDoc of Mix.Tasks.Magma.Text.Finalize
## Moduledoc
A Mix task for generating the final text from a given preview document.
```sh
mix magma.text.finalize "Name of preview document"
```