From 4abc6f233f39852e1fced661b60c00ad4bb1293a Mon Sep 17 00:00:00 2001 From: Jack Firth Date: Fri, 28 Aug 2015 11:20:46 -0700 Subject: [PATCH] Add stability notice and reference unstable/lens in main docs --- lens/main.scrbl | 5 +++++ lens/private/doc-util/main.rkt | 1 + lens/private/doc-util/stability-notice.rkt | 10 ++++++++++ 3 files changed, 16 insertions(+) create mode 100644 lens/private/doc-util/stability-notice.rkt diff --git a/lens/main.scrbl b/lens/main.scrbl index 3a39180..51ad76b 100644 --- a/lens/main.scrbl +++ b/lens/main.scrbl @@ -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"] diff --git a/lens/private/doc-util/main.rkt b/lens/private/doc-util/main.rkt index 39cac12..9238bb8 100644 --- a/lens/private/doc-util/main.rkt +++ b/lens/private/doc-util/main.rkt @@ -3,6 +3,7 @@ syntax/parse/define "deflenses.rkt" "include-sections.rkt" "lenses-examples.rkt" +"stability-notice.rkt" for-label lens unstable/lens diff --git a/lens/private/doc-util/stability-notice.rkt b/lens/private/doc-util/stability-notice.rkt new file mode 100644 index 0000000..05d72fe --- /dev/null +++ b/lens/private/doc-util/stability-notice.rkt @@ -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) "."))