Sara Burke saralilyb

How Clojure's documentation can leapfrog other languages

Summary

I made a documentation generator that cashes in on Clojure's dynamism. See the play-cljs docs (a ClojureScript game library) for an example of its output.

The Problem

Like many of you, I've often wondered what my final regret will be on my deathbed. My best guess came to me in a dream recently. I was walking across the charred earth of an apocalyptic future world, maneuvering around the remains of the less fortunate. I was startled to find a young girl, barely holding onto her life. She murmured something to me. I asked her to repeat it, and she said more loudly: "I...wish your Clojure projects didn't have such crappy documentation."

Cheat Sheets are greate but they are not a substitute for learning the framework and reading the documentation as we most certainly have not covered every potential example here. Please refer to the Rails Command Line Docs for more information.

Command Line Generator Info

Reference

You can get all of this information on the command line.

rails generate with no generator name will output a list of all available generators and some information about global options. rails generate GENERATOR --help will list the options that can be passed to the specified generator.

	import { one, two, pipe } from './utils';

	class Main {
	public sentence() {
	return pipe<string>('word',
	addPeriod,
	capitalize);
	}
	}

	import {
	AfterViewInit,
	Component,
	ElementRef,
	Input,
	OnDestroy,
	ViewChild
	} from '@angular/core';
	import { fromEvent } from 'rxjs';
	import { pairwise, switchMap, takeUntil } from 'rxjs/operators';

	stata_summary <-
	function(
	x,
	...
	) {
	# summarize
	mod <- x
	x <- summary(x)

	# find outcome variable

	# # A Plain Old Ruby Object (poro) with Rails logger support:
	class ServiceObject
	def initialize(foo)
	@logger = Logger.new(STDOUT)
	@foo = foo
	end

	def call
	do_something
	end

	require "rubygems"
	require "twitter"

	# get these from apps.twitter.com
	CONSUMER_KEY = "foo"
	CONSUMER_SECRET = "bar"
	OAUTH_TOKEN = "blee"
	OAUTH_TOKEN_SECRET = "baz"

	TWITTER_USER = "your_username" # needs to be the one associated with keys above

	/**
	HTML

	<ion-scroll #mapScroll scrollX="true" zoom="true" scrollY="true" >

	<img #image alt="loading.." src="https;//placehold.it/1000x1000">

	</ion-scroll>

	# Usage:
	# ========
	# FirebaseAdmin::Auth.verify_id_token(your_id_token)
	#
	# The method call follows the same API of the Node.js, JAVA and Python SDKs.
	# See https://firebase.google.com/docs/auth/admin/verify-id-tokens#verify_id_tokens_using_the_firebase_admin_sdk

	# Dependencies:
	# ---------------
	# gem 'activesupport'