Skip to content

Docs cleanup #528

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

Closed
wants to merge 3 commits into from
Closed

Docs cleanup #528

wants to merge 3 commits into from

Conversation

priyaramani
Copy link
Contributor

@priyaramani priyaramani commented Jun 17, 2022

Update docs to reflect current verbiage/outputs for builtins, default scheduler and app handles. Also removes some unnecessary arguments in examples and fixes some typos.

Test:
cd docs && make html
(with airflow.md commented out)

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 17, 2022
@codecov
Copy link

codecov bot commented Jun 17, 2022

Codecov Report

Merging #528 (c3ab36e) into main (a551741) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #528   +/-   ##
=======================================
  Coverage   94.75%   94.75%           
=======================================
  Files          65       65           
  Lines        3949     3949           
=======================================
  Hits         3742     3742           
  Misses        207      207           
Impacted Files Coverage Δ
torchx/cli/__init__.py 100.00% <ø> (ø)
torchx/specs/__init__.py 96.29% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a551741...c3ab36e. Read the comment docs.

@priyaramani priyaramani requested a review from PaliC June 17, 2022 21:06
@facebook-github-bot
Copy link
Contributor

@priyaramani has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

Copy link
Member

@d4l3k d4l3k left a comment

Choose a reason for hiding this comment

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

LGTM thanks for the fixes!

@d4l3k
Copy link
Member

d4l3k commented Jun 17, 2022

There is a failing doctest FYI https://github.com/pytorch/torchx/runs/6942958011?check_suite_focus=true

@facebook-github-bot
Copy link
Contributor

@priyaramani has updated the pull request. You must reimport the pull request before landing.

@facebook-github-bot
Copy link
Contributor

@priyaramani has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@d4l3k d4l3k deleted the docs branch October 28, 2022 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants