pre-srfi / hints

Hints provide inline documentation and predicate-based type information

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SRFI nnn: hints

by Amirouche Boubekki, ...

Status

Early Draft

Abstract

??? abstract, preferably shorter than 200 words. Please outline the need for, and design of, the proposal.

Issues

??? Optional section that may point out things to be resolved. This will not appear in the final SRFI.

Rationale

??? detailed rationale. This should be 200-500 words long. Please explain why the proposal should be incorporated as a standard feature in Scheme implementations. List related standards and SRFIs, including dependencies, conflicts, and replacements. If there are other standards which this proposal will replace or with which it will compete, please explain why the present proposal is a substantial improvement.

Survey of prior art

GitHub's version of Markdown can make tables. For example:

System Procedure Signature
System A jumble list elem
System B bungle elem list
System C frob list elem predicate

Specification

(any-of predicate? ...)

(every-of predicate? ...)

(each-of predicate? ... predicaten?)

(anything? obj ...)

(false? obj)

(make-hint documentation [arguments? [values? [raise?]]]) string? procedure? procedure? procedure? → hint?

The default value of ARGUMENTS?, VALUES? and RAISE? is anything?.

(hint? obj) anything? → boolean?

(hint-arguments? hint obj ...) hint? anything? → boolean?

(hint-values? hint obj ...) hint? anything? → boolean?

(hint-raise? hint obj) hint? anything? → boolean?

(hint-documentation hint) hint? → string?

Returns the documentation associated with HINT.

(define/hint identifier hint expr)

Examples

Implementation

??? explanation of how it meets the sample implementation requirement (see process), and the code, if possible, or a link to it Source for the sample implementation.

Acknowledgements

??? Give credits where credits is due.

References

??? Optional section with links to web pages, books and papers that helped design the SRFI.

Copyright

Copyright (C) Firstname Lastname (20XY).

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Hints provide inline documentation and predicate-based type information


Languages

Language:Makefile 100.0%