Page MenuHomePhabricator

Fix up config docblocks and extract config out of core types documentation
ClosedPublic

Authored by schrockn on Tue, Feb 11, 8:43 PM.

Details

Summary

This moves a config section to the top-level of the API docs,
which consist mostly of fairly bare doc blocks.

Tracking that here -- https://github.com/dagster-io/dagster/issues/2139.

This also extracts references to the config system in types.rst.

Resolves https://github.com/dagster-io/dagster/issues/2125

This also fixes up all config arguments throughout the system.

Test Plan

Read

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

schrockn created this revision.Tue, Feb 11, 8:43 PM
schrockn updated this revision to Diff 9527.Tue, Feb 11, 8:47 PM
schrockn retitled this revision from docs to Fix up config docblocks and extract config out of core types documentation.
schrockn edited the summary of this revision. (Show Details)
schrockn edited the test plan for this revision. (Show Details)

upmessage

schrockn updated this revision to Diff 9528.Tue, Feb 11, 8:47 PM

upmessage

schrockn added inline comments.Tue, Feb 11, 8:49 PM
docs/sections/api/apidocs/config.rst
2

This needs to be written. This is not a new section, just a moved section.

schrockn updated this revision to Diff 9538.Tue, Feb 11, 9:43 PM
schrockn edited the test plan for this revision. (Show Details)
schrockn added reviewers: alangenfeld, max.

upmessage

alangenfeld accepted this revision.Wed, Feb 12, 1:57 AM

make sure to check the docs build for warnings - i recently re-did all the indenting on these to fix warnings there

This revision is now accepted and ready to land.Wed, Feb 12, 1:57 AM

confirmed no new indentation warnings