GitHunt
EM

emacs-vs/docstr

A document string minor mode

License: GPL v3
MELPA
MELPA Stable

docstr

A document string minor mode.

CI
Docs

This package provides a simple solution for the insertion of documentation strings into code.

๐Ÿ› ๏ธ Contribute

PRs Welcome
Elisp styleguide
Donate on paypal
Become a patron

If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!

๐Ÿ”ฌ Development

To run the test locally, you will need the following tools:

Install all dependencies and development dependencies:

eask install-deps --dev

To test the package's installation:

eask package
eask install

To test compilation:

eask compile

๐Ÿชง The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

eask lint checkdoc

The standard package linter:

eask lint package
```ge

๐Ÿ“ P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

โšœ๏ธ License

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.

Languages

Emacs Lisp98.6%Shell0.5%Makefile0.5%Batchfile0.5%

Contributors

GNU General Public License v3.0
Created November 5, 2020
Updated March 5, 2026
emacs-vs/docstr | GitHunt