Skip to content

Commit 853a2b6

Browse files
b4handjrlmtierney
authored andcommitted
Update docstrings to specify the type of path needed to install firefox addons. (#4881)
This change helps the user give the correct full path to the addon they would like to install for firefox. Marionette is expecting a full path. Fixes #4858
1 parent aca7a3e commit 853a2b6

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

py/selenium/webdriver/firefox/firefox_profile.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ def _install_extension(self, addon, unpack=True):
243243
"""
244244
Installs addon from a filepath, url
245245
or directory of addons in the profile.
246-
- path: url, path to .xpi, or directory of addons
246+
- path: url, absolute path to .xpi, or directory of addons
247247
- unpack: whether to unpack unless specified otherwise in the install.rdf
248248
"""
249249
if addon == WEBDRIVER_EXT:

py/selenium/webdriver/firefox/webdriver.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,10 @@ def install_addon(self, path, temporary=None):
237237
Returns identifier of installed addon. This identifier can later
238238
be used to uninstall addon.
239239
240+
:param path: Absolute path to the addon that will be installed.
241+
240242
:Usage:
241-
driver.install_addon('firebug.xpi')
243+
driver.install_addon('/path/to/firebug.xpi')
242244
"""
243245
payload = {"path": path}
244246
if temporary is not None:

0 commit comments

Comments
 (0)