Page MenuHomePhabricator

Flesh out type system documentation
ClosedPublic

Authored by max on Tue, Nov 5, 1:16 AM.

Details

Reviewers
alangenfeld
schrockn
Group Reviewers
Restricted Project
Commits
R1:a236018922b5: Flesh out type system documentation
Summary

Includes a fix to the semantics of the default machinery for Selector and cleans update
the public API surface.

Test Plan

Unit

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

max created this revision.Tue, Nov 5, 1:16 AM
alangenfeld accepted this revision.Tue, Nov 5, 4:35 PM
alangenfeld added inline comments.
docs/sections/api/apidocs/types.rst
10

?

python_modules/dagster/dagster/core/types/field.py
85–87

might want to tweak your example here since config={'word': Field... would be the "preferred" way to write this

python_modules/dagster/dagster/core/types/field_utils.py
267–271

Defines a config dict that includes arbitrarily many extra fields.

I found this sentence strange when i first read it - it made sense after i read the second paragraph but before the word "extra" puzzled me. Consider dropping this first sentence or rewording.

This revision is now accepted and ready to land.Tue, Nov 5, 4:35 PM
max updated this revision to Diff 6229.Tue, Nov 5, 5:26 PM

RuntimeType

max updated this revision to Diff 6230.Tue, Nov 5, 5:27 PM

Encoding

max updated this revision to Diff 6232.Tue, Nov 5, 5:38 PM

Public API

max updated this revision to Diff 6233.Tue, Nov 5, 5:45 PM

Fix typecheck

max updated this revision to Diff 6236.Tue, Nov 5, 6:10 PM

Rebase & kick

Harbormaster failed remote builds in B5009: Diff 6230!
Harbormaster failed remote builds in B5008: Diff 6229!
Harbormaster failed remote builds in B5005: Diff 6226!
Harbormaster failed remote builds in B5004: Diff 6225!