Skip to main content

A Python package for automatically generating docstrings based on function arguments and return types.

Project description

Auto Commenter

Auto Commenter is a Python package that automatically generates docstrings for your Python functions and classes based on their arguments and return types. It uses abstract syntax tree (AST) analysis to inspect the code and generate informative comments.

Features

  • Automatically generates docstrings for functions and classes.
  • Infers argument types based on common patterns (e.g., num, data, arr).
  • Supports return type detection, including for int, str, list, dict, pd.DataFrame, and np.ndarray.
  • Easily integrate into your workflow to improve code documentation.

Installation

You can install Auto Commenter from PyPI using pip:

pip install auto-commenter

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

auto_commenter-0.1.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

auto_commenter-0.1.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file auto_commenter-0.1.0.tar.gz.

File metadata

  • Download URL: auto_commenter-0.1.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for auto_commenter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 59546e5bb168e9d19e405bca036bc5726b47f1fe9275d06992a1eea23b6999aa
MD5 4e3265b699367e86623410ea5ae8dceb
BLAKE2b-256 507dc8bed08d1121531fc787b9ea659d81d127174b5d9bab0a694955286358f9

See more details on using hashes here.

File details

Details for the file auto_commenter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: auto_commenter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for auto_commenter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 584941d00be24df77a27c0ac244a87e1ace597e50427bf9ad70c1bb5faca54f8
MD5 18f1b830b94cb53c7f9563287347d74f
BLAKE2b-256 45ce80a40dae8e9bf092cb8cbe4bd55e2b4f2ec3ac5c0ee8b6be6b1f4ec75dac

See more details on using hashes here.

Supported by

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