Skip to content

Commit

Permalink
fix language
Browse files Browse the repository at this point in the history
  • Loading branch information
LFISHER7 committed Sep 26, 2023
1 parent 6dbcfc1 commit 621a479
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/releasing-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Only certain file types will be reviewed and released from the secure server. Se
* **Other**
* `txt` files can be released, but you should consider whether the output can be produced as a table, which is easier to review.
* `json` files can be released, but as with tables, make sure that the attributes are easily understandable for reviewers. If the output can be represented as a table, you should consider converting it.
* `html` files can be released if you are producing a report style output that is intended to be hosted on [reports.opensafely.org](https://reports.opensafely.org/) but please note the points below:
* `html` files can be released if you are producing a report that is intended to be hosted on [reports.opensafely.org](https://reports.opensafely.org/) but please note the points below:
* `html` files are harder to review than other output types, so should be reserved for reports which require both contextual text and embedded outputs. If you can produce your report locally, using individually released files, you should.
* Make sure that any code blocks are not rendered in the rendered report if they are not needed. You can find [examples showing how to do this for Jupyter notebooks and R markdown files](reports/intro.md#producing-reports).
* Each individual output within the report should be requested for release separately, with the contextual information outlined above.
Expand Down

0 comments on commit 621a479

Please sign in to comment.