Store function metadata in a machine readable format

Abierto
#49 6 comentarios 5 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
json, markdown, python
Área
documentation, testing, tooling

Línea de trabajo

Comienza revisando los archivos de especificación Markdown existentes y el análisis actual de las firmas de funciones mediante expresiones regulares en la suite de pruebas. Identifica qué metadatos deben extraerse además de las firmas y, después, decide cómo debería representarlos JSON y cómo se generarían las secciones relevantes de la especificación. Se considera terminado cuando la suite de pruebas consume metadatos legibles por máquinas sin analizar las firmas desde Markdown, mientras la prosa permanece en la especificación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
281
Forks
52
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de data-apis/array-api

Todos los issues de data-apis/array-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.