Skip to content

Commit df3300d

Browse files
Michael-OverallKimberly Sereduck
authored andcommitted
change def axe.execute() to axe.run() to mirror axe-core naming (#162)
1 parent e57cce3 commit df3300d

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ Usage
6262
# Inject axe-core javascript into page.
6363
axe.inject()
6464
# Run axe accessibility checks.
65-
results = axe.execute()
65+
results = axe.run()
6666
# Write results to file
6767
axe.write_results(results, 'a11y.json')
6868
driver.close()
6969
# Assert no violations are found
7070
assert len(results["violations"]) == 0, axe.report(results["violations"])
7171
72-
The method ``axe.execute()`` accepts two parameters: ``context`` and ``options``.
72+
The method ``axe.run()`` accepts two parameters: ``context`` and ``options``.
7373

7474
For more information on ``context`` and ``options``, view the `aXe documentation here <https://github.com/dequelabs/axe-core/blob/master/doc/API.md#parameters-axerun>`_.
7575

axe_selenium_python/axe.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def inject(self):
2626
with open(self.script_url, "r", encoding="utf8") as f:
2727
self.selenium.execute_script(f.read())
2828

29-
def execute(self, context=None, options=None):
29+
def run(self, context=None, options=None):
3030
"""
3131
Run axe against the current page.
3232

axe_selenium_python/tests/test_axe.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def _perform_axe_run(driver):
6161
driver.get("file://" + _DEFAULT_TEST_FILE)
6262
axe = Axe(driver)
6363
axe.inject()
64-
data = axe.execute()
64+
data = axe.run()
6565
return data
6666

6767

0 commit comments

Comments
 (0)