Current section

Files

Jump to
magma docs.magma artefacts final modules Mix Tasks Magma Prompt Copy ModuleDoc of Mix.Tasks.Magma.Prompt.Copy.md
Raw

docs.magma/artefacts/final/modules/Mix/Tasks/Magma/Prompt/Copy/ModuleDoc of Mix.Tasks.Magma.Prompt.Copy.md

---
magma_type: Artefact.Version
magma_artefact: ModuleDoc
magma_concept: "[[Mix.Tasks.Magma.Prompt.Copy]]"
magma_draft: "[[Generated ModuleDoc of Mix.Tasks.Magma.Prompt.Copy (2023-11-02T17:18:06)]]"
created_at: 2023-11-02 17:20:26
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.Prompt.Copy
## Moduledoc
A Mix task for rendering a specified prompt, resolving all transclusions, and copying the result to the clipboard.
```sh
$ mix magma.prompt.copy "Name of prompt"
```