allenai / allenai/allenact

Improve inline documentation for primary abstractions

Open
#123 0 comments 0 reactions 2 assignees Claimed by @klemenkotar View on GitHub
documentation
Dominant language
Python
Stars
383
Forks
59
PR merge metrics
No merged PRs in 30d

Description

## 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.