pyjanitor-devs/pyjanitor

[DOC] Update documentation to include which types of errors can be thrown

Open

#512 opened on Jul 29, 2019

View on GitHub
 (1 comment) (2 reactions) (1 assignee)Python (164 forks)batch import
being worked ondocfixgood first issuegood intermediate issue

Repository metrics

Stars
 (1,217 stars)
PR merge metrics
 (Avg merge 2d 12h) (4 merged PRs in 30d)

Description

Brief Description of Fix

Right now, our documentation lists inputs and return values, but it does not include information about what types of errors functions normally raise. This is helpful information if you're working with try/except blocks, so that you know what errors to expect. And just as a matter of completeness, it's good to know all the outputs of a function, including likely errors.

Relevant Context

This would pretty much apply to every docstring, though I'm guessing we'll just add them piecemeal. According to my very poor understanding of Sphinx (I'm looking at here), we should be able to add documentation like

:raises: ValueError, TypeError

as we go along.

Contributor guide

Research direction
Identify functions missing error documentation and add :raises: directives to docstrings following Sphinx conventions.
Tech stack
python
Domain
documentationdata
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70