From fb52e318dc99c4ed74b7b0e0694e997ce71fc358 Mon Sep 17 00:00:00 2001 From: Jason Lai Date: Tue, 23 Apr 2024 05:07:16 +0800 Subject: [PATCH] [Docs] add validation file tpye (#5259) Signed-off-by: jason.lai --- .../user_guide/data_types_and_io/flytefile.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/user_guide/data_types_and_io/flytefile.md b/docs/user_guide/data_types_and_io/flytefile.md index 97330669a5..883b7c5e0c 100644 --- a/docs/user_guide/data_types_and_io/flytefile.md +++ b/docs/user_guide/data_types_and_io/flytefile.md @@ -68,4 +68,26 @@ You can run the workflow locally as follows: :lines: 75-95 ``` +You can enable type validation if you have the [python-magic](https://pypi.org/project/python-magic/) package installed. + +```{eval-rst} +.. tabs:: + + .. group-tab:: Mac OS + + .. code-block:: bash + + brew install libmagic + + .. group-tab:: Linux + + .. code-block:: bash + + sudo apt-get install libmagic1 +``` + +:::{note} +Currently, type validation is only supported on the `Mac OS` and `Linux` platforms. +::: + [flytesnacks]: https://github.com/flyteorg/flytesnacks/tree/master/examples/data_types_and_io/