pyjanitor-devs/pyjanitor

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

Open

#512 建立於 2019年7月29日

在 GitHub 查看
 (1 留言) (2 反應) (1 負責人)Python (164 fork)batch import
being worked ondocfixgood first issuegood intermediate issue

倉庫指標

Star
 (1,217 star)
PR 合併指標
 (平均合併 2天 12小時) (30 天內合併 4 個 PR)

描述

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.

貢獻者指南