Store function metadata in a machine readable format

Aperta
#49 6 commenti 5 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
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
json, markdown, python
Ambito
documentation, testing, tooling

Direzione di ricerca

Inizia esaminando i file di specifica Markdown esistenti e l’attuale analisi delle firme delle funzioni tramite espressioni regolari nella suite di test. Identifica quali metadati devono essere estratti oltre alle firme, quindi decidi come JSON dovrebbe rappresentarli e come verrebbero generate le sezioni pertinenti della specifica. Il lavoro è completato quando la suite di test utilizza metadati leggibili dalle macchine senza analizzare le firme da Markdown, mentre la prosa rimane nella specifica.

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

Descrizione

Tools

It would be useful for the test suite to have the function metadata stored in a machine readable format. Currently I am parsing the function signatures from the spec files using some regular expressions, and I will probably end up parsing some other information such as types as well. This works fine for now, but it would be cleaner if this data were stored in a machine readable format, say in JSON, and the relevant parts of the spec documents generated from that automatically.

To be sure, not everything in the spec needs to be in JSON, just the parts that will need to be extracted for other things as well, such as the test suite. There should still be a lot of plain English descriptions of behavior.

This is likely too much work for version 1 given that we already have things inline in the Markdown, but it's something to consider for future iterations.

Lingua principale
Python
Stelle
281
Fork
52
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

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 data-apis/array-api

Tutte le issue di data-apis/array-api

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.