Skip to content

Commit d207f65

Browse files
authored
docs: specify the inherited-members directive for job classes (#2244)
It seems that versions of python earlier than 3.10 may have had issues processing inherited members annotations, and accidentally include inherited members by default. As we recently worked to excise older versions of python in this repo, it seems we're now correctly processing sphinx directives, which means we no longer emit docstrings for inherited members. This PR adds a minor sphinx directive to include inherited members for the job classes, and I've confirmed locally by running the `docsfx` nox job that the inherited members do now get included in the docfx_yaml output.
1 parent 4400f26 commit d207f65

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/reference.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Job
2222
===
2323

2424
.. automodule:: google.cloud.bigquery.job
25+
:inherited-members:
2526

2627
.. toctree::
2728
:maxdepth: 2

0 commit comments

Comments
 (0)