mirror of
https://github.com/cool-RR/PySnooper.git
synced 2026-01-23 02:14:04 +00:00
add usage to package docstring; fixes #83
This commit is contained in:
parent
750ef4c639
commit
7e845b8f49
1 changed files with 15 additions and 0 deletions
|
|
@ -1,5 +1,20 @@
|
|||
# Copyright 2019 Ram Rachum and collaborators.
|
||||
# This program is distributed under the MIT license.
|
||||
"""PySnooper - Never use print for debugging again
|
||||
|
||||
Usage:
|
||||
|
||||
import pysnooper
|
||||
|
||||
@pysnooper.snoop()
|
||||
def number_to_bits(number):
|
||||
...
|
||||
|
||||
A log will be written to stderr showing the lines executed and variables
|
||||
changed in the decorated function.
|
||||
|
||||
For more information, see https://github.com/cool-RR/PySnooper
|
||||
"""
|
||||
|
||||
from .pysnooper import snoop
|
||||
from .variables import Attrs, Exploding, Indices, Keys
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue