Skip to content

Commit

Permalink
DOC: Fix the docstring of DataFetcher.
Browse files Browse the repository at this point in the history
  • Loading branch information
zhangt58 committed Oct 16, 2023
1 parent c1eaf9a commit 78fd584
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions phantasy/library/pv/epics_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,10 +299,10 @@ class DataFetcher:
>>> ]
>>> # instantiation
>>> data_fetcher = DataFetcher(pvs, timeout=10)
>>> # fetch the data
>>> avg, df = data_fetcher(timespan=2.0, verbose=True)
>>> # fetch the data, see fetch_data() for the parameters definition.
>>> avg, df = data_fetcher(time_span=2.0, verbose=True)
>>> # another fetch
>>> avg, _ = data_fetcher(timespan=1.0)
>>> avg, _ = data_fetcher(1.0)
>>> # clean up (optional)
>>> data_fetcher.reset()
"""
Expand Down

0 comments on commit 78fd584

Please sign in to comment.