Skip to content

Commit bfa1d40

Browse files
committed
Update docs for get_save_filename_input to reflect actual api spec
1 parent 8767400 commit bfa1d40

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

python/interaction.py

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,10 +1273,16 @@ def get_open_filename_input(prompt: str, ext: str = "") -> Optional[str]:
12731273
:param str prompt: Prompt to display.
12741274
:param str ext: Optional, file extension
12751275
:Example:
1276-
>>> get_open_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)")
1277-
'foo.exe'
12781276
>>> get_open_filename_input("filename:", "*.py")
12791277
'test.py'
1278+
>>> get_open_filename_input("filename:", "All Files (*)")
1279+
'test.py'
1280+
>>> get_open_filename_input("filename:", "Executables (*.exe)")
1281+
'foo.exe'
1282+
>>> get_open_filename_input("filename:", "Executables (*.exe *.com)")
1283+
'foo.exe'
1284+
>>> get_open_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)")
1285+
'foo.exe'
12801286
"""
12811287
value = ctypes.c_char_p()
12821288
if not core.BNGetOpenFileNameInput(value, prompt, ext):
@@ -1299,7 +1305,19 @@ def get_save_filename_input(prompt: str, ext: str = "", default_name: str = "")
12991305
:param str ext: Optional, file extension
13001306
:param str default_name: Optional, default file name.
13011307
:Example:
1302-
>>> get_save_filename_input("filename:", "exe", "foo.exe")
1308+
>>> get_save_filename_input("filename:", "*.py", "test.py")
1309+
filename: test.py
1310+
'test.py'
1311+
>>> get_save_filename_input("filename:", "All Files (*)", "test.py")
1312+
filename: test.py
1313+
'test.py'
1314+
>>> get_save_filename_input("filename:", "Executables (*.exe)", "foo.exe")
1315+
filename: foo.exe
1316+
'foo.exe'
1317+
>>> get_save_filename_input("filename:", "Executables (*.exe *.com)", "foo.exe")
1318+
filename: foo.exe
1319+
'foo.exe'
1320+
>>> get_save_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)", "foo.exe")
13031321
filename: foo.exe
13041322
'foo.exe'
13051323
"""

0 commit comments

Comments
 (0)