From f3c7443839a69bdb49b8313e6eef7a3834feb85f Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Fri, 23 May 2025 23:39:21 -0400 Subject: add cross-referencing to docs for save and create_database --- python/binaryview.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'python') diff --git a/python/binaryview.py b/python/binaryview.py index 00188902..bb26f7a7 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -4210,6 +4210,8 @@ class BinaryView: """ ``create_database`` writes the current database (.bndb) out to the specified file. + .. 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` + :param str filename: path and filename to write the bndb to, this string `should` have ".bndb" appended to it. :param callback progress_func: optional function to be called with the current progress and total count. :param SaveSettings settings: optional argument for special save options. @@ -4697,6 +4699,8 @@ class BinaryView: """ ``save`` saves the original binary file to the provided destination ``dest`` along with any modifications. + .. warning:: This API will only save the original file from a view. To save a database, use :py:func:`create_database`. + :param str dest: destination path and filename of file to be written :return: True on success, False on failure :rtype: bool -- cgit v1.3.1