https://github.com/kurama622/pycomment

Generate Python docstring to your Python source code.
https://github.com/kurama622/pycomment

Last synced: 3 months ago
JSON representation

Generate Python docstring to your Python source code.

• Host: GitHub
• URL: https://github.com/kurama622/pycomment
• Owner: Kurama622
• License: mit
• Created: 2020-12-31T08:59:10.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-02-05T03:29:27.000Z (over 4 years ago)
• Last Synced: 2025-03-01T03:45:47.760Z (8 months ago)
• Language: Python
• Size: 817 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# pycomment

![vim](https://img.shields.io/badge/vim-neovim-red) ![gvim](https://img.shields.io/badge/gvim-blue)

ENGLISH  |  [中文版](./README_cn.md)

## Show

![pycomment](./screenshut/pycomment1.gif)

![pycomment2](./screenshut/pycomment2.gif)

## Introduction

Automatic generate docstring including inputed parameters, returned variables, and their types.

## Install

- [x] vim-plug

```vim

Plug 'demonlord1997/pycomment', {'for','python'}

```

- [x] dein

```vim

[[plugins]]

repo = 'demonlord1997/pycomment'

on_ft = 'python'

```

## Settings

If you want to use default settings, you can write following contents in your configure.

```vim

let g:pycomment_mark_mapping = 1

```

In this case, pressing `Ctrl+c` in the function definition or the function body will expand docstring. Press ` + ` will replace `<++>` but you will not enter insert mode.

```vim

let g:pycomment_mark_mapping = 0

nmap  

nmap   (pycomment)

nmap  /<++>:nohlsearchc4l

```

Press `Ctrl+c` will expand docstring.

Press ` + ` will replace `<++>` and enter insert mode.