At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
| # | |
| # Jekyll Generator for SCSS | |
| # | |
| # (File paths in this description relative to jekyll project root directory) | |
| # Place this file in ./_plugins | |
| # Place .scss files in ./_scss | |
| # Compiles .scss files in ./_scss to .css files in whatever directory you indicated in your config | |
| # Config file placed in ./_sass/config.rb | |
| require 'compass' |
| (setq ruby-deep-indent-paren nil) | |
| (defadvice ruby-indent-line (after unindent-closing-paren activate) | |
| (let ((column (current-column)) | |
| indent offset) | |
| (save-excursion | |
| (back-to-indentation) | |
| (let ((state (syntax-ppss))) | |
| (setq offset (- column (current-column))) | |
| (when (and (eq (char-after) ?\)) | |
| (not (zerop (car state)))) |
| void function() {//closure | |
| var global = this | |
| , _initKeyboardEvent_type = (function( e ) { | |
| try { | |
| e.initKeyboardEvent( | |
| "keyup" // in DOMString typeArg | |
| , false // in boolean canBubbleArg | |
| , false // in boolean cancelableArg | |
| , global // in views::AbstractView viewArg |
| <!doctype html> | |
| <html> | |
| <head> | |
| <!-- Encoding --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame --> | |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"></meta> | |
| function getText(node) { | |
| if (node.nodeType === 3) { | |
| return node.data; | |
| } | |
| var txt = ''; | |
| if (node = node.firstChild) do { | |
| txt += getText(node); |