diff options
| author | Brandon Miller <brandon@vector35.com> | 2024-03-01 14:25:38 -0500 |
|---|---|---|
| committer | Brandon Miller <bkmiller89@icloud.com> | 2024-03-25 14:44:58 -0400 |
| commit | 3697a06ba40acbb4386bcdb25ea92143d200f5a1 (patch) | |
| tree | 3def787df4ea2e9eacf002d1784cbd297be2e662 /python/filemetadata.py | |
| parent | 4765a8d16105d2bdd2ca32524af80fdf6e80481e (diff) | |
Docs note for original_filename with projects
Diffstat (limited to 'python/filemetadata.py')
| -rw-r--r-- | python/filemetadata.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/python/filemetadata.py b/python/filemetadata.py index 4dbde1a7..a5dda467 100644 --- a/python/filemetadata.py +++ b/python/filemetadata.py @@ -191,7 +191,11 @@ class FileMetadata: @property def original_filename(self) -> str: - """The original name of the binary opened if a bndb, otherwise reads or sets the current filename (read/write)""" + """ + The original name of the binary opened if a bndb, otherwise reads or sets the current filename (read/write) + + .. note:: With projects, ``bv.file.original_filename`` queries the path of the binary as staged in the project directory. Use ``bv.project_file.name`` to query the original name of the opened binary. + """ return core.BNGetOriginalFilename(self.handle) @original_filename.setter |
