Closed Bug 1704779 Opened 4 years ago Closed 4 years ago

Fix documentation generated for GeckoDriver & browser modules

Categories

(Remote Protocol :: Marionette, task, P3)

Default
task

Tracking

(firefox90 fixed)

RESOLVED FIXED
90 Branch
Tracking Status
firefox90 --- fixed

People

(Reporter: jdescottes, Assigned: jdescottes)

References

Details

Attachments

(1 file)

As discussed the class exported by driver.js is GeckoDriver and not driver, so we should update https://searchfox.org/mozilla-central/rev/3de2db87f3c9001ae478318d47a2ca3427574382/testing/marionette/doc/internals/driver.rst#3

driver module
=============
.. js:autoclass:: driver
  :members:
Summary: Fix documentation generated for GeckoDriver module → Fix documentation generated for GeckoDriver & browser modules

the browser module is also incorrect, it points to the event module documentation: https://firefox-source-docs.mozilla.org/testing/marionette/internals/browser.html

We already had a bug for at least the event module issue. When I find it I will dupe.

Pushed by jdescottes@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/b39f71467030 [marionette] Fix documentation generated for driver and browser modules r=marionette-reviewers,whimboo
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → 90 Branch
Product: Testing → Remote Protocol
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: