From 2e96c074a2bdc096156655c8c115e57e602541bc Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Fri, 13 Oct 2023 14:53:03 +0200 Subject: [PATCH] PR comments --- vizro-core/docs/pages/user_guides/custom_charts.md | 4 ++-- vizro-core/docs/pages/user_guides/custom_components.md | 2 +- vizro-core/docs/pages/user_guides/run.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/vizro-core/docs/pages/user_guides/custom_charts.md b/vizro-core/docs/pages/user_guides/custom_charts.md index 2b40c04e4..8f1a9cad7 100644 --- a/vizro-core/docs/pages/user_guides/custom_charts.md +++ b/vizro-core/docs/pages/user_guides/custom_charts.md @@ -3,9 +3,9 @@ This guide shows you how to create custom charts and how to add them to your dashboard. The [`Graph`][vizro.models.Graph] model accepts the `figure` argument, where you can enter _any_ [`plotly.express`](https://plotly.com/python/plotly-express/) chart as explained in the user guide on [components][graph]. -In general, the usage of our custom chart decorator `@capture("graph")` is required if your plotly express chart requires any post-update calls or customization. +In general, the usage of our custom chart decorator `@capture("graph")` is required if your plotly chart requires any post-update calls or customization. -**When to use our custom chart decorator?** +When to use our custom chart decorator - If you want to use any of the post figure update calls by `plotly` e.g., `update_layout`, `update_xaxes`, `update_traces`, etc. (for more details, see the docs on [plotly's update calls](https://plotly.com/python/creating-and-updating-figures/#other-update-methods)) - If you want to use a custom-created [`plotly.graph_objects.Figure()`](https://plotly.com/python/graph-objects/) object (in short, `go.Figure()`) and add traces yourself via [`add_trace`](https://plotly.com/python/creating-and-updating-figures/#adding-traces) diff --git a/vizro-core/docs/pages/user_guides/custom_components.md b/vizro-core/docs/pages/user_guides/custom_components.md index 47c901cc0..315c19484 100644 --- a/vizro-core/docs/pages/user_guides/custom_components.md +++ b/vizro-core/docs/pages/user_guides/custom_components.md @@ -8,7 +8,7 @@ In general, you can create a custom component based on any dash-compatible compo !!!warning - When creating your own custom components, you are responsible for the security of your component (e.g. setting HTML from code which might expose users to cross-site scripting). Vizro cannot guarantee + When creating your own custom components, you are responsible for the security of your component (e.g. prevent setting HTML from code which might expose users to cross-site scripting). Vizro cannot guarantee the security of custom created components, so make sure you keep this in mind when publicly deploying your dashboard. diff --git a/vizro-core/docs/pages/user_guides/run.md b/vizro-core/docs/pages/user_guides/run.md index 10cb791c8..0e2c9a428 100644 --- a/vizro-core/docs/pages/user_guides/run.md +++ b/vizro-core/docs/pages/user_guides/run.md @@ -91,7 +91,7 @@ in the cmd. For more gunicorn configuration, please refer to [gunicorn docs](htt ## Deployment of Vizro app -In general, Vizro is functioning as a higher-level wrapper around Dash. So if you want to deploy a Vizro app, similar steps apply as if you were to deploy a Dash app. +In general, Vizro is returning a Dash app. So if you want to deploy a Vizro app, similar steps apply as if you were to deploy a Dash app. For more details, see the docs on [Dash for deployment](https://dash.plotly.com/deployment#heroku-for-sharing-public-dash-apps). For reference (where app is a Dash app):