4.2.10 Version History

► |  | Scribble: The Racket Documentation Tool

1 | Getting Started
2 | @ Syntax
3 | High-Level Scribble API
4 | Scribbling Documentation
5 | Literate Programming
6 | Low-Level Scribble API
7 | Running scribble
| Index

► | 4 | Scribbling Documentation

4.1 | Getting Started with Documentation
4.2 | Manual Forms
4.3 | Racket
4.4 | Evaluation and Examples
4.5 | In-Source Documentation
4.6 | BNF Grammars
4.7 | Compatibility Libraries

▼ | 4.2 | Manual Forms

4.2.1 | Typesetting Code
4.2.2 | Documenting Modules
4.2.3 | Documenting Forms, Functions, Structure Types, and Values
4.2.4 | Documenting Classes and Interfaces
4.2.5 | Documenting Signatures
4.2.6 | Various String Forms
4.2.7 | Links
4.2.8 | Indexing
4.2.9 | Bibliography
4.2.10 | Version History
4.2.11 | Miscellaneous
4.2.12 | Index-Entry Descriptions
4.2.13 | Manual Rendering Style

On this page:

history
tasty-burrito

top contents ← prev up next →

##### 4.2.10`` Version History🔗ℹ

> syntax (history clause ...+)
> clause |  | = |  | #:added version-expr
> |  | | |  | #:changed version-expr content-expr
> > | version-expr |  | : |  | valid-version?
> > | content-expr |  | : |  | content?

Generates a block for version-history notes. The version refers to a package as determined by a defmodule or declare-exporting declaration within an enclosing section.

Normally, history should be used at the end of a defform, defproc, etc., entry, although it may also appear in a section that introduces a module (that has been added to a package). In the case of a changed entry, the content produced by content-expr should normally start with a capital letter and end with a period, but it can be a sentence fragment such as “Added a #:changed form.”

Examples:

> @defthing[tasty-burrito burrito?]{
> Compatible with the API of a sandwich, but not legally a
> sandwich in Massachusetts.
> @history[#:added "1.0"
> #:changed "1.1" "Refactored tortilla."
> #:changed "1.2" @elem{Now includes @emph{guacamole}.}]
> }

> Renders like:

> > > > value tasty-burrito : burrito?

> > > Compatible with the API of a sandwich, but not legally a sandwich in Massachusetts.

> > > Added in version 1.0 of package scribble-lib.
> > > Changed in version 1.1: Refactored tortilla.
> > > Changed in version 1.2: Now includes guacamole.

Added in version 1.1 of package scribble-lib.

top contents ← prev up next →