https://github.com/alphapapa/obvious.el

Who needs comments when the code is so obvious
https://github.com/alphapapa/obvious.el

emacs

Last synced: 2 months ago
JSON representation

Who needs comments when the code is so obvious

• Host: GitHub
• URL: https://github.com/alphapapa/obvious.el
• Owner: alphapapa
• License: gpl-3.0
• Created: 2022-07-21T20:01:09.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-05T20:07:39.000Z (over 2 years ago)
• Last Synced: 2023-03-23T00:28:52.483Z (almost 2 years ago)
• Topics: emacs
• Language: Emacs Lisp
• Homepage:
• Size: 487 KB
• Stars: 43
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+TITLE: obvious.el

/Who needs comments when the code is so obvious./

* Screenshots

Before:

[[images/before.png]]

After:

[[images/after.png]]

* Installation

Add =obvious.el= to your ~load-path~, then ~(require 'obvious)~ and enable ~obvious-mode~.

* Usage

When the comments are getting to you, activate ~obvious-mode~.  If you don't even want to see header comments, customize the option ~obvious-headers~.

*Note:* For now, the mode should be disabled when writing a comment.

* Changelog

** v0.1

Initial release.

* Credits

Inspired by Anders Lindgren's [[https://github.com/Lindydancer/nocomments-mode][nocomments-mode]] (which works differently, by preserving whitespace where comments are).

* License

GPLv3