Skip to content

Commit 8a3f8a0

Browse files
lwjohnst86martonvagosignekb
authored
docs: 🏗️ move .puml into pseudocode (#1021)
## Description This PR moves the PlantUML diagram over into pseudocode and also adds a basic Mermaid diagram of the input and output flow. <!-- Select quick/in-depth as necessary --> This PR needs an in-depth review. ## Checklist - [x] Updated documentation - [x] Ran `just run-all` --------- Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com> Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com>
1 parent 29491d0 commit 8a3f8a0

File tree

4 files changed

+132
-86
lines changed

4 files changed

+132
-86
lines changed

docs/design/interface/functions.qmd

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -117,19 +117,21 @@ details.
117117
:::
118118

119119
::: {.callout-warning collapse="true"}
120-
### `write_resource_data_to_raw(path, data_path)`
121-
122-
Copy the file from `data_path` over into the resource location given by
123-
`path`. This will compress the file and use a timestamped, unique file
124-
name to store it as a backup. See the explanation of this file in the
125-
[Outputs](outputs.qmd) section. Use `path_resource_raw()` to provide the
126-
correct `path` location. Copies and compresses the file, and outputs the
127-
path object of the created file.
128-
129-
![Diagram showing the internal function flow of the
130-
`write_resource_data_to_raw()`
131-
function.](images/core/write-resource-data-to-raw.svg){#fig-write-resource-data-to-raw
132-
fig-alt="A Plant UML schematic of the detailed code flow within the `write_resource_data_to_raw()` function."}
120+
### `write_resource_data_to_raw(data_path, resource_properties)`
121+
122+
See the help documentation with `help(write_resource_data_to_raw)` for
123+
more details.
124+
125+
```{mermaid}
126+
flowchart
127+
in_data_path[/data_path/]
128+
in_properties[/resource_properties/]
129+
function("write_resource_data_to_raw()")
130+
out[("{path}/{timestamp}-{uuid}.{ext}.csv")]
131+
in_data_path --> function
132+
in_properties --> function
133+
function --> out
134+
```
133135
:::
134136

135137
::: {.callout-warning collapse="true"}

docs/design/interface/images/core/write-resource-data-to-raw.puml

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)