Skip to content

Commit 20a5962

Browse files
committed
[py] Change comment to docstring
1 parent d8caae6 commit 20a5962

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

py/generate_api_module_listing.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@
1616
# under the License.
1717

1818

19-
# -----------------------------------------------------------------
20-
# This script recursively scans the `selenium` package directory
21-
# to find all modules, then generates the `py/docs/source/api.rst`
22-
# file containing a listing of all modules in separate sections.
23-
# The `api.rst` file is later used by `sphinx-autogen` to generate
24-
# sphinx autodoc stub pages used in the Python API documentation.
25-
# See `py/tox.ini` for how it is invoked.
19+
"""This script recursively scans the `selenium` package directory
20+
to find all modules, then generates the `py/docs/source/api.rst`
21+
file containing a listing of all modules in separate sections.
22+
The `api.rst` file is later used by `sphinx-autogen` to generate
23+
sphinx autodoc stub pages used in the Python API documentation.
24+
See `py/tox.ini` for how it is invoked."""
2625

2726
import os
2827
import site

0 commit comments

Comments
 (0)