author examples as .py files?

Aperta
#62 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia esaminando come pytest-examples individua ed elabora attualmente il codice Python negli esempi Markdown. Chiarisci se l’obiettivo è scrivere file .py autonomi, incorporare file Python o usare un altro formato, quindi definisci test che dimostrino il workflow scelto e confermino che gli esempi Markdown esistenti continuino a funzionare.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

thanks for the great package - its really easy to use and useful.

I was wondering if it could be possible to author the examples as python files rather than markdown files with python code blocks?
... because writing the python code in a .md without the benefit of code-completion etc. is a little painful

maybe:

  • by embedding a python file into the markdown examples file at runtime (<< include myexample.py >>)
  • or perhaps as a %format python file with %[markdown] blocks?

or maybe you already have a way to avoid this irritation?

many thanks

Lingua principale
Python
Stelle
181
Fork
29
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pydantic/pytest-examples

Tutte le issue di pydantic/pytest-examples

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.