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

Update Basic Tutorial about missing @hydra.main return #837

Closed
wants to merge 1 commit into from

Conversation

kychow
Copy link

@kychow kychow commented Jul 29, 2020

Add info about lack of return value for @hydra.main due to ambiguity to the basics tutorial. See #769

Motivation

(Write your motivation for proposed changes here.)

Have you read the Contributing Guidelines on pull requests?

Yes/No

Test Plan

(How should this PR be tested? Do you require special setup to run the test or repro the fixed bug?)

Related Issues and PRs

(Is this PR part of a group of changes? Link the other relevant PRs and Issues here. Use https://help.github.com/en/articles/closing-issues-using-keywords for help on GitHub syntax)

Add info about lack of return value for @hydra.main due to ambiguity to the basics tutorial. See facebookresearch#769
@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 Jul 29, 2020
@omry
Copy link
Collaborator

omry commented Jul 29, 2020

Thanks @kychow, please open an issue for discussion before filing a PR.

@omry
Copy link
Collaborator

omry commented Jul 30, 2020

Thanks @kychow.

This doesn't really fit in the basic tutorial.
The basic tutorial is introducing Hydra to users, this is not something users following the tutorial should do.

I am considering creating a page describing @hydra.main in more details (similar to this which will get into details of this nature).

@omry omry closed this Jul 30, 2020
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.

3 participants