google/seq2seq

Check docstrings

Open

#23 opened on Mar 12, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (5,587 stars) (1,329 forks)batch import
dochelp wanted

Description

Due to a lot of refactoring many Python docstrings are currently outdated. Need to go through the code, make sure they are still correct, and update where necessary.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Python knowledgeFamiliarity with docstrings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review Python source files (e.g., in seq2seq/models/ or seq2seq/encoders/) that have been refactored. Compare existing docstrings to current function signatures and behavior, and update any that are outdated. Check the one comment on the issue for any additional guidance.