Merge pull request #197 from jackfirth/add-stability-notice-and-ref

Add stability notice and ref
This commit is contained in:
Jack Firth 2015-08-30 14:16:29 -07:00
commit 658da10829
4 changed files with 17 additions and 1 deletions

View File

@ -1,4 +1,4 @@
# lens [![Build Status](https://travis-ci.org/jackfirth/lens.svg?branch=master)](https://travis-ci.org/jackfirth/lens) [![Coverage Status](https://coveralls.io/repos/jackfirth/lens/badge.svg)](https://coveralls.io/r/jackfirth/lens) [![Stories in Ready](https://badge.waffle.io/jackfirth/lens.png?label=ready&title=Ready)](https://waffle.io/jackfirth/lens) [![Scribble Docs](https://img.shields.io/badge/Docs-Scribble%20(lens)-blue.svg)](http://pkg-build.racket-lang.org/doc/lens/index.html) [![Scribble Docs (unstable)](https://img.shields.io/badge/Docs-Scribble%20(unstable/lens)-blue.svg)](http://pkg-build.racket-lang.org/doc/unstable-lens/index.html) ![Version](https://img.shields.io/badge/Version-2.0-green.svg)
# lens ![Version](https://img.shields.io/badge/Version-2.0-green.svg) [![Build Status](https://travis-ci.org/jackfirth/lens.svg?branch=master)](https://travis-ci.org/jackfirth/lens) [![Coverage Status](https://coveralls.io/repos/jackfirth/lens/badge.svg)](https://coveralls.io/r/jackfirth/lens) [![Stories in Ready](https://badge.waffle.io/jackfirth/lens.png?label=ready&title=Ready)](https://waffle.io/jackfirth/lens) [![Scribble Docs](https://img.shields.io/badge/Docs-Scribble%20-blue.svg)](http://pkg-build.racket-lang.org/doc/lens/index.html)
A Racket package for creating and composing pure functional lenses.

View File

@ -1,5 +1,7 @@
#lang scribble/manual
@(require "private/doc-util/main.rkt")
@title[#:style '(toc)]{Lenses}
@defmodule[lens]
@ -14,8 +16,11 @@ representation of getters and setters in object-oriented languages.
source code: @url["https://github.com/jackfirth/lens"]
@stability-notice[unstable/lens]
@local-table-of-contents[]
@secref{unstable/lens}
@include-section["private/base/main.scrbl"]
@include-section["private/compound/main.scrbl"]
@include-section["private/list/main.scrbl"]

View File

@ -3,6 +3,7 @@ syntax/parse/define
"deflenses.rkt"
"include-sections.rkt"
"lenses-examples.rkt"
"stability-notice.rkt"
for-label
lens
unstable/lens

View File

@ -0,0 +1,10 @@
#lang sweet-exp racket/base
provide stability-notice
require scribble/manual
(define-syntax-rule (stability-notice id)
(list "This library is stable, backwards compatibility will be maintained. For experimental features see "
(racketmodname id) "."))