Skip to content

Commit f3c7443

Browse files
committed
add cross-referencing to docs for save and create_database
1 parent 98d81b7 commit f3c7443

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

python/binaryview.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4210,6 +4210,8 @@ def create_database(
42104210
"""
42114211
``create_database`` writes the current database (.bndb) out to the specified file.
42124212
4213+
.. warning:: This API will only save a database, NOT the original file from a view. To save the original file, use :py:func:`save`. To update a database, use :py:func:`save_auto_snapshot`
4214+
42134215
:param str filename: path and filename to write the bndb to, this string `should` have ".bndb" appended to it.
42144216
:param callback progress_func: optional function to be called with the current progress and total count.
42154217
:param SaveSettings settings: optional argument for special save options.
@@ -4697,6 +4699,8 @@ def save(self, dest: Union['fileaccessor.FileAccessor', str]) -> bool:
46974699
"""
46984700
``save`` saves the original binary file to the provided destination ``dest`` along with any modifications.
46994701
4702+
.. warning:: This API will only save the original file from a view. To save a database, use :py:func:`create_database`.
4703+
47004704
:param str dest: destination path and filename of file to be written
47014705
:return: True on success, False on failure
47024706
:rtype: bool

0 commit comments

Comments
 (0)