https://github.com/anntzer/structured-docstrings

Structured and composable (numpy)-docstrings (proof-of-concept stage)
https://github.com/anntzer/structured-docstrings

Last synced: 10 days ago
JSON representation

Structured and composable (numpy)-docstrings (proof-of-concept stage)

• Host: GitHub
• URL: https://github.com/anntzer/structured-docstrings
• Owner: anntzer
• License: mit
• Created: 2017-10-15T06:21:28.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-11T06:25:24.000Z (almost 7 years ago)
• Last Synced: 2024-10-27T12:50:19.618Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 3.91 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
structured docstrings

=====================

Try ::

   pydoc structdoc_example

or ::

   >>> import structdoc_example

   >>> print(structdoc_example.func.__doc__)

   >>> structdoc_example.otherfunc.__doc__

or ::

   In [1]: import structdoc_example

   In [2]: structdoc_example.func?

interpolated docstrings

=======================

Try ::

   pydoc interpolate_example

or ::

   >>> import interpolate_example

   >>> print(interpolate_example.func.__doc__)

or ::

   In [1]: import interpolate_example

   In [2]: interpolate_example.func?