Skip to main content

No project description provided

Project description

Docstring generator

Install instruction

# Install docstring package
pip install .

# Copy vim plugin to vim pack
mkdir -p ~/.vim/packs/plugins/start
ln -s $PWD/plugins ~/.vim/packs/plugins/start/generate-docstring

TODO:

  • add tox support [ ]
  • parse existing docstring [ ]
  • don't fail if no typing (annotation) [X]
  • recusrive subscipt (ex: typing.Dict) [X]
  • add raise on function [X]
  • module attribute [ ]
  • module name, extract filename [X]

Dev tools:

poetry run pylint --rcfile=.pylintrc ./src/

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

generate-docstring-0.1.1.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

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

generate_docstring-0.1.1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file generate-docstring-0.1.1.tar.gz.

File metadata

  • Download URL: generate-docstring-0.1.1.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for generate-docstring-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fc8c6817b6edd35b7689cb89b076bd51c673df8590a8a8520e9162f95dbc8938
MD5 cf4cba03bd162e16b90ca0d90a664d4e
BLAKE2b-256 2fda5bdb77ef8fd5d340759c3a410c98cd33e90ca928f5de0d0fd46e8c00b12d

See more details on using hashes here.

File details

Details for the file generate_docstring-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for generate_docstring-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15852edc594d675cf29c1fed6a717c4ca60cd52eebdc7b0fdd55ad1ed5ba3b7a
MD5 1fd4b5d505b35f951ac8e9204a6f7ada
BLAKE2b-256 9a72310b46982237fe529b822c4f4d262e6a6ca97c53867657410309819c1790

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