Page MenuHomePhabricator

add docstrings for ComputeLogManager
ClosedPublic

Authored by prha on Feb 6 2020, 7:08 PM.

Details

Test Plan

viewed sphinx docs

Diff Detail

Repository
R1 dagster
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

prha created this revision.Feb 6 2020, 7:08 PM
prha updated this revision to Diff 9329.Feb 6 2020, 7:25 PM

update type check for ComputeLogFileData

prha added a reviewer: max.Feb 6 2020, 7:31 PM
max requested changes to this revision.Feb 7 2020, 10:08 PM

thanks much, we need to add the :members: line for sphinx to generate method docs

docs/sections/api/apidocs/internals.rst
116

should be

.. autoclass:: ComputeLogManager
  :members:
This revision now requires changes to proceed.Feb 7 2020, 10:08 PM
prha updated this revision to Diff 9402.Feb 7 2020, 11:08 PM

add method docs

max accepted this revision.Feb 7 2020, 11:36 PM
This revision is now accepted and ready to land.Feb 7 2020, 11:36 PM
This revision was automatically updated to reflect the committed changes.