Skip to content

The README appears to be out of date, and directs the new user to a doc string that doesn't seem to exist #70

@dfmorrison

Description

@dfmorrison

The README says

The documentation can be found in the docstrings, start with the
package :it.bese.fiveam (nicknamed 5AM).

But that package appears not to have a docstring:

CL-USER> (find-package :it.bese.fiveam)
#<PACKAGE "IT.BESE.FIVEAM">
CL-USER> (documentation * t)
NIL
CL-USER>

and

dfm@helmsley:/tmp/fiveam$ cat version.sexp
;; -*- lisp -*-
"1.4.2"
dfm@helmsley:/tmp/fiveam$ grep ':documentation' src/package.lisp
dfm@helmsley:/tmp/fiveam$

Google turns up documentation at

https://common-lisp.net/project/fiveam/docs/index.html

but it seems out of date. For example, it says

Variable DEBUG-ON-ERROR T if we should drop into a debugger on error, NIL otherwise.

Variable DEBUG-ON-FAILURE T if we should drop into a debugger on a failing check, NIL otherwise.

but looking at the source it appears that both these variables are now deprecated. Is there current documentation, suitable for a new user, available somewhere?

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions