Skip to content

Commit

Permalink
DOC make the persistence warning same as user guide (#259)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrinjalali committed Dec 20, 2022
1 parent e7b655c commit 0f48b2f
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions skops/io/_persist.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@ def dump(obj: Any, file: str | Path | BinaryIO) -> None:
.. warning::
This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.
Parameters
----------
Expand All @@ -78,10 +77,9 @@ def dumps(obj: Any) -> bytes:
.. warning::
This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.
Parameters
----------
Expand All @@ -102,10 +100,9 @@ def load(file: str | Path, trusted: bool | Sequence[str] = False) -> Any:
.. warning::
This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.
Parameters
----------
Expand Down Expand Up @@ -141,10 +138,9 @@ def loads(data: bytes, trusted: bool | Sequence[str] = False) -> Any:
.. warning::
This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.
Parameters
----------
Expand Down

0 comments on commit 0f48b2f

Please sign in to comment.