Skip to content

Commit

Permalink
[Docs] add validation file tpye (#5259)
Browse files Browse the repository at this point in the history
Signed-off-by: jason.lai <[email protected]>
  • Loading branch information
jasonlai1218 authored Apr 22, 2024
1 parent e3e614a commit fb52e31
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/user_guide/data_types_and_io/flytefile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/

0 comments on commit fb52e31

Please sign in to comment.