anomaly / anomaly/gallagher

Provide a set of examples references from the documentation

Aperta
#41 0 commenti 0 reazioni 1 assegnatario Rivendicata da @devraj Vedi su GitHub
Lingua principale
Python
Stelle
17
Fork
2
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

**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)

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.