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

Updated README.md with docs from test folder #740

Closed
wants to merge 1 commit into from
Closed

Updated README.md with docs from test folder #740

wants to merge 1 commit into from

Conversation

d4rk5eed
Copy link

@d4rk5eed d4rk5eed commented Jun 7, 2017

Relates to #738

Since @josevalim answered

We only generate documentation from compiled files in the current environment. Given test/support/graphql_case.ex is compiled only in test, you probably want to do MIX_ENV=test mix docs

It's not obivious to fetch deps for test environment (as guys like me just copy-paste samples of code to project), so some minor README update

@sourcelevel-bot
Copy link

Hello, @d4rk5eed! This is your first Pull Request that will be reviewed by Ebert, an automatic Code Review service. It will leave comments on this diff with potential issues and style violations found in the code as you push new commits. You can also see all the issues found on this Pull Request on its review page. Please check our documentation for more information.

@josevalim
Copy link
Member

Thank you @d4rk5eed! However, your case is very uncommon, so I would prefer to leave it out of the README as to not confuse those who use it rather the regular way. ❤️

@josevalim josevalim closed this Jun 7, 2017
@d4rk5eed d4rk5eed deleted the add-test-env-readme branch June 7, 2017 07:19
@eksperimental
Copy link
Contributor

why don't we create a FAQ file or something of the like?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants