allenai / allenai/allenact

Improve inline documentation for primary abstractions

Abierto
#123 0 comentarios 0 reacciones 2 asignados Reclamado por @klemenkotar Ver en GitHub
documentation
Lenguaje dominante
Python
Estrellas
383
Forks
59
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

## Problem

All of our primary abstractions should have good documentation and be fully typed.

## Solution

Go through all of these critical files and ensure that:

1. All classes/methods/modules have doc strings and these doc strings enumerate all the parameters if relevant.
2. All (except in rare cases where doing so would be highly unpractical) parameters are typed.

## Dependencies

None

Guía de contribución

Abrir la guía de contribución

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.