mononobi / docsify

A simple docstring inspector.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docsify

A simple docstring inspector.

Docsify is a utility package which helps to transform python methods docstring information into usable python objects.

Features

  • Extract short description
  • Extract long description
  • Extract required params
  • Extract optional params
  • Extract exceptions
  • Extract return type
  • Extract return description
  • Extract custom keyword values

Installing

Install using pip:

pip install docsify

Example:

Single:

Batch:

About

A simple docstring inspector.

License:GNU General Public License v3.0


Languages

Language:Python 100.0%