@@ -8,22 +8,7 @@ its interface along with explanations for these design decisions. It
88primarily serves as a reference for us to develop from and track what
99has been finished and what remains to be done.
1010
11- We use symbols to indicate parts of the design that are actively being
12- worked on, done, or planned (see table below). For work that is planned
13- or is in progress, we include the function signatures and docstrings to
14- clarify the design. Once the interface is implemented (done), we will
15- remove the signatures from the documentation and point to the reference
16- documentation instead. The symbols we use are described in the table
17- below.
18-
19- | Status | Description |
20- | :-----------------------------:| :----------------------------------------|
21- | {{< var done >}} | Interface that has been implemented. |
22- | {{< var wip >}} | Interface that is currently being worked on. |
23- | {{< var planned >}} | Interface that is planned, but isn't being worked on currently. |
24-
25- : A table showing the symbols used to indicate the status of interface
26- components, along with their descriptions.
11+ {{< include /docs/includes/_ design-status.qmd >}}
2712
2813## {{< var planned >}} ` seedcase-flower `
2914
@@ -132,6 +117,8 @@ flowchart LR
132117 config_file["_flower.toml or<br>pyproject.toml<br>[file]"]
133118 build("build")
134119 style_opt("--style<br>[option]")
120+ verbose_opt("--verbose<br>[option]")
121+ output_dir_opt("--output-dir<br>[option]")
135122 templates["Templates<br>[folder with<br>Jinja files]"]
136123 output["Output<br>[files and<br>folders]"]
137124 config{"config"}
@@ -140,6 +127,8 @@ flowchart LR
140127 templates --> config_file
141128 config_file -- "either" --> config
142129 style_opt -- "or" --> config
130+ output_dir_opt --> config
131+ verbose_opt --> build
143132 config --> build
144133 build --> output
145134```
@@ -236,6 +225,10 @@ settings. This will allow for quicker testing of different styles as
236225well as prevent the unintended side effects that might arise when a
237226style is mixed with incompatible configuration settings.
238227
228+ This overriding behaviour also applies to the other CLI options,
229+ ` --output-dir ` and ` --verbose ` ; if they are used on the CLI, they
230+ override the corresponding settings in the configuration file.
231+
239232::: callout-important
240233Flower does not check whether the ` datapackage.json ` file is correct or
241234not, it will only read and parse it. If an error happens during reading
0 commit comments