Skip to content

Make docstring optional #259

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 1 commit into from
Closed

Conversation

aivanou
Copy link
Contributor

@aivanou aivanou commented Oct 15, 2021

Summary:
The diff makes the docstring optional when defining the component function.
Use argparse formatter that also prints default values

Differential Revision: D31671125

@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

@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 Oct 15, 2021
aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Differential Revision: D31671125

fbshipit-source-id: 2fb71f6b98e212700479003ca4d15a01cec0e571
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Differential Revision: D31671125

fbshipit-source-id: 278c5a2dfaacc3dd604bd23ec3f44eaf21d13547
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

@codecov
Copy link

codecov bot commented Oct 15, 2021

Codecov Report

Merging #259 (bf29d7a) into main (6236614) will decrease coverage by 0.05%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #259      +/-   ##
==========================================
- Coverage   91.61%   91.56%   -0.06%     
==========================================
  Files          60       60              
  Lines        2767     2749      -18     
==========================================
- Hits         2535     2517      -18     
  Misses        232      232              
Impacted Files Coverage Δ
torchx/specs/api.py 99.28% <100.00%> (ø)
torchx/specs/file_linter.py 99.30% <100.00%> (-0.08%) ⬇️
torchx/specs/finder.py 97.36% <100.00%> (ø)

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 6236614...bf29d7a. Read the comment docs.

aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Differential Revision: D31671125

fbshipit-source-id: 32ea960b633460566bb7593f603ec524cbdd05d8
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Differential Revision: D31671125

fbshipit-source-id: 73a00ba8ba64fa1cdd4dc57008bf1ab050775bab
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Differential Revision: D31671125

fbshipit-source-id: 2cb867f06742287019f628046eacdfca374e9aa6
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Git issue: pytorch#253

Differential Revision: D31671125

fbshipit-source-id: 5e7bd775fe1548ce46fc43108033db9b9cd0d1d6
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Git issue: pytorch#253

Reviewed By: kiukchung

Differential Revision: D31671125

fbshipit-source-id: 938faa5c0979d2b5e8c159384ebecc0274e95fff
aivanou added a commit to aivanou/torchx-1 that referenced this pull request Oct 15, 2021
Summary:
Pull Request resolved: pytorch#259

* Refactor docstring functions: combines two functions that retrieve docstring into one
* Make docstring optional
* Remove docstring validator

Git issue: pytorch#253

Reviewed By: kiukchung

Differential Revision: D31671125

fbshipit-source-id: d391fc3ed9cfd7669bca93e8f6591fa6259367c3
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

@aivanou aivanou force-pushed the export-D31671125 branch 2 times, most recently from 28f6cc7 to bf29d7a Compare October 15, 2021 22:06
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D31671125

@facebook-github-bot
Copy link
Contributor

This pull request has been merged in 74e07d8.

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. fb-exported Merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants