Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add usage docs #81

Merged
merged 5 commits into from
Apr 30, 2024
Merged

Add usage docs #81

merged 5 commits into from
Apr 30, 2024

Conversation

amitschang
Copy link
Member

@amitschang amitschang commented Apr 16, 2024

Working through resolving #80. This PR covers the major sections. I will save extensions and observers for another PR to make this more digestible.

Copy link

codecov bot commented Apr 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2f9dfd7) to head (4ddbd1e).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #81   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          570       570           
=========================================
  Hits           570       570           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@amitschang amitschang marked this pull request as ready for review April 24, 2024 18:07
@amitschang amitschang requested a review from a team as a code owner April 24, 2024 18:07
@amitschang amitschang requested review from ryanhausen and xiangchenjhu and removed request for ryanhausen April 24, 2024 18:07
@amitschang amitschang changed the title wip adding docs Add usage docs Apr 24, 2024
Copy link

@xiangchenjhu xiangchenjhu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Only a few minor comments


from dplutils.cli import cli_run

pipline = ...instantiate executor from graph...

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pipline -> pipeline ?

docs/source/command_line.rst Show resolved Hide resolved
@xiangchenjhu
Copy link

Thanks!

@amitschang amitschang merged commit ef555f9 into main Apr 30, 2024
12 checks passed
@amitschang amitschang deleted the gh-80-docs branch April 30, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants