Skip to main content

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 -r '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.

Source Distribution

docgrep-0.1.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file docgrep-0.1.tar.gz.

File metadata

  • Download URL: docgrep-0.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for docgrep-0.1.tar.gz
Algorithm Hash digest
SHA256 86b5ada1237f1c272d8e574901f022476bdc618667d586bf3744c66027782a0b
MD5 5a43e5e4c1a059a597d8da8898f5c119
BLAKE2b-256 5bc73b5980c77af90933dafccce4772412ffa87f6f3c68cf8e8f8d40b3c72467

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page