https://github.com/myint/docgrep

Like grep, but only searches through docstrings (in Python files)
https://github.com/myint/docgrep

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/myint/docgrep
• Owner: myint
• Created: 2014-04-06T16:17:24.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-06T19:42:46.000Z (over 10 years ago)
• Last Synced: 2024-10-12T23:30:42.652Z (about 1 month ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/docgrep
• Size: 141 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
=======

docgrep

=======

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.)

        """