Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create an examples directory with documentation and tests

See original GitHub issue

We need a comprehensive set of examples demonstrating some more advanced concepts. Examples should have:

README.rst that would be linked from the docs
unified way to set up so that users can install the example and poke around
requirements.txt (or equivalent), if needed, listing dependencies
tests that will be run from the test suite making sure the examples keep working

Possible example ideas:

tiny example with just some configuration options to serve as a template for other
full-text search focused example with custom analyzers, auto complete
time based index group including index management (possibly using curator?)
parent/child example (including custom _doc_type.matches
example migration (using _reindex API), replaces #293
…

Any additional ideas welcome!

Issue Analytics

State:
Created 6 years ago
Reactions:4
Comments:7 (6 by maintainers)

Top GitHub Comments

1reaction

3lnccommented, Jan 9, 2018

2 cents from me: maybe we should expand docstrings on methods/classes, including some simple examples there.

This is not replacement of example project by any means.

0reactions

honzakralcommented, Jul 2, 2018

Some examples have been added in the examples directory so I will close the issue and we will track any need for specific examples as separate issues.

Top Results From Across the Web

Testing with files and directories - Testfixtures - Read the Docs

You will need to make sure that the directory is cleaned up as required. Using with Sybil#. Sybil is a tool for testing...

Living Documentation: The Examples Directory

This is documentation that stays updated based on the current code. ... Here where I work, we recently create an examples directory with ......

doctest — Test interactive Python examples — Python 3.11.1 ...

DocTestFinder : Finds all docstrings in a given module, and uses a DocTestParser to create a DocTest from every docstring that contains interactive...

Writing and Organizing Tests - Cypress Documentation

To see an example of every command used in Cypress, open the 2-advanced-examples folder within your cypress/e2e folder. Fixture Files. Fixtures are used...

Creating New Test-Cases — Fehmpytests 1.0 documentation

Go into the folder fehmpytests. · Create a folder <test-case> where <test-case> is the name of the new case. · Inside <test-case>, create...