anomaly / anomaly/gallagher

Provide a set of examples references from the documentation

Abierto
#41 0 comentarios 0 reacciones 1 asignado Reclamado por @devraj Ver en GitHub
Lenguaje dominante
Python
Estrellas
17
Forks
2
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

**Is your feature request related to a problem? Please describe.**
It would be good to have runnable `examples` for the end user to be able to almost copy and paste and run on their console. Particularly when it comes to using the API client.

**Describe the solution you'd like**
Inspired by the developer experience provided by companies like Stripe who do an excellent job at providing accurate examples of runnable code.

While we reference examples in our documentation we should also maintain a folder of `examples` which the developers can vendor in.

Note that we have a strong set of `tests` that we can draw from and the `cli` demonstrates the use of most of the endpoints.

The aim of this is to extend these working examples and keep them in sync.

> A point to consider is how we are going to keep these up to date as the project evolves.

**Describe alternatives you've considered**
NA

**Additional context**
See projects shillelagh for [examples](https://github.com/betodealmeida/shillelagh/tree/main/examples)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.