Page MenuHomeElementl

Improves docstrings for config API.
ClosedPublic

Authored by bob on Oct 21 2020, 9:10 PM.

Details

Summary

Adds missing descriptions for parameters in the config API docs. Also fixes docstrings for formatting and Sphinx doc gen.

Test Plan

Render docs website locally && buildkite

Diff Detail

Repository
R1 dagster
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Nice, thank you for this! I think we also want ScalarUnion, which is both missing a doc block and missing from the documentation.

This revision now requires changes to proceed.Oct 22 2020, 7:44 AM
  • Adds docstrings for ScalarUnion.
  • Adds docstrings for ScalarUnion.
sashank added inline comments.
python_modules/dagster/dagster/config/config_schema.py
40

Nice

python_modules/dagster/dagster/config/config_type.py
151

s/values/value

This revision is now accepted and ready to land.Oct 22 2020, 8:01 PM
  • Improves wording and adds examples for Noneable.
This revision was landed with ongoing or failed builds.Oct 22 2020, 8:46 PM
This revision was automatically updated to reflect the committed changes.