diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2025-05-23 23:39:21 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2025-05-23 23:39:21 -0400 |
| commit | f3c7443839a69bdb49b8313e6eef7a3834feb85f (patch) | |
| tree | 0a15638f2377153865899b7c1345ad598dbd02ca /python/binaryview.py | |
| parent | 98d81b780952c2c91fe686c55bb867d193472749 (diff) | |
add cross-referencing to docs for save and create_database
Diffstat (limited to 'python/binaryview.py')
| -rw-r--r-- | python/binaryview.py | 4 |
1 files changed, 4 insertions, 0 deletions
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 |
