4.3.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 | Style Guide
4.3 | Manual Forms
4.4 | Racket
4.5 | Evaluation and Examples
4.6 | In-Source Documentation
4.7 | BNF Grammars
4.8 | Compatibility Libraries

▼ | 4.3 | Manual Forms

4.3.1 | Typesetting Code
4.3.2 | Documenting Modules
4.3.3 | Documenting Forms, Functions, Structure Types, and Values
4.3.4 | Documenting Classes and Interfaces
4.3.5 | Documenting Signatures
4.3.6 | Various String Forms
4.3.7 | Links
4.3.8 | Indexing
4.3.9 | Bibliography
4.3.10 | Version History
4.3.11 | Miscellaneous
4.3.12 | Index-Entry Descriptions
4.3.13 | Manual Rendering Style

On this page:

history

top ← prev up next →

##### 4.3.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.”

Added in version 1.1 of package scribble-lib.

top ← prev up next →