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

Improve documentation for use of templates #100

Open
svanoort opened this issue Oct 23, 2015 · 2 comments
Open

Improve documentation for use of templates #100

svanoort opened this issue Oct 23, 2015 · 2 comments

Comments

@svanoort
Copy link
Owner

Needs to be in the first example, tutorial, and more common in example files and advanced guide so people can see it in action. Have had a couple questions on this and for every question asked there are probably 3 people who went away frustrated.

Templating should be treated as part of the most common use for docs purposes, not just an advanced feature.

@svanoort
Copy link
Owner Author

Good examples:

  • Login & Request for Github or Reddit APIs + a few sample API calls
  • Show use with hardcoded parameters for credentials + passing via cmdline
  • Demonstrate use of environment variables and generators for test series (got stripped out of examples in revisions)

@svanoort
Copy link
Owner Author

svanoort commented Dec 8, 2015

Note: add to the quickstart and README.md file.

Edit: tie this to 1.7.x because it probably will need changes with #101 and #75

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

No branches or pull requests

1 participant