Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Like grep, but searches for matches in docstrings.

Project description

Like grep, but only searches through docstrings (in Python code).

Installation

From pip:

$ pip install --upgrade docgrep

Example

$ docgrep 'Python 3.4' .
./asyncio/futures.py:113: """This class is *almost* compatible with concurrent.futures.Future.

    Differences:

    - result() and exception() do not take a timeout argument and
      raise an exception when the future isn't done yet.

    - Callbacks registered with add_done_callback() are always called
      via the event loop's call_soon_threadsafe().

    - This class is not compatible with the wait() and as_completed()
      methods in the concurrent.futures package.

    (In Python 3.4 or later we may be able to unify the implementations.)
    """

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for docgrep, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size docgrep-0.2.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page