Page MenuHomeElementl

improve dynamic map & collect api docs
ClosedPublic

Authored by alangenfeld on Apr 2 2021, 5:22 PM.

Details

Summary

Screen Shot 2021-04-02 at 12.21.28 PM.png (1×890 px, 254 KB)

Test Plan
make build
make dev

Diff Detail

Repository
R1 dagster
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

alangenfeld edited the test plan for this revision. (Show Details)
alangenfeld added inline comments.
docs/content/_apidocs.mdx
45

the real change - everything else is auto formatter

docs/sphinx/sections/api/apidocs/solids.rst
27–30

users shouldn't be interacting with these objects so i don't think its useful to show the arbitrary subset of members functions that happened to have comments

Harbormaster returned this revision to the author for changes because remote builds failed.Apr 2 2021, 5:41 PM
Harbormaster failed remote builds in B28389: Diff 34839!
alangenfeld edited the test plan for this revision. (Show Details)

snapshoot

max added inline comments.
docs/sphinx/sections/api/apidocs/solids.rst
27–30

better is to mark the members that we should show, or to include the :meta private: directive in docstrings we're skipping

python_modules/dagster/dagster/core/definitions/events.py
536–541

can also do

:py:class:`~dagster.Output`
537

let's call this the downstream pipeline subset? is it the whole downstream dag, or until a collect call is hit?

548

this is confusing

551–552

maybe clarify that this is defined on the solid

This revision is now accepted and ready to land.Apr 5 2021, 10:54 PM
This revision was automatically updated to reflect the committed changes.