Julien Fischer b18ebaa473 Update coding standards for interfaces in the ...

Estimated hours taken: 1
Branches: main

Update coding standards for interfaces in the
standard library.  The intent is to improve the
library reference guide.

compiler/notes/coding_standards.html:
	Modify the coding standards to specify how descriptive
	comments for library procedures should be placed.
	By fixing a style (hopefully) the library reference guide
	should have a more consistent appearance.

	Specify that predmode syntax should be used in preference
	to a separate mode declaration if a predicates has only
	one mode.

	Specify that descriptive comments for procedures should
	ideally state under which conditions the procedure can
	fail (if it can) or throw an exception.

2004-04-05 13:45:51 +00:00

..

.cvsignore

…

.nocopyright

New file. Contains links to the other files in this directory,

2003-10-31 03:30:08 +00:00

allocation.html

Delete an incorrect comment.

2003-10-23 07:24:40 +00:00

authors.html

…

bootstrapping.html

Fix a typo and make a few changes suggest by others.

1999-07-19 18:31:05 +00:00

BUGS

…

coding_standards.html

Update coding standards for interfaces in the

2004-04-05 13:45:51 +00:00

compiler_design.html

Update the documentation of the module structure after the movement

2004-03-23 11:02:45 +00:00

ENVIRONMENT_VARS

…

failure.html

Clarify that these describe the LLDS back-end only.

2003-10-23 06:06:30 +00:00

gc_and_c_code.html

Clarify that this file only applies to the LLDS back-end.

2003-11-05 08:42:10 +00:00

glossary.html

…

IMPLICIT_QUANTIFICATION

…

index.html

New file. Contains links to the other files in this directory,

2003-10-31 03:30:08 +00:00

macro_notes

…

Mmakefile

Delete references to the recently deleted module_system.html.

2003-11-01 11:06:30 +00:00

overall_design.html

Document the `analysis' directory.

2003-10-30 04:24:52 +00:00

promise_ex.html

…

release_checklist.html

Delete references to the recently deleted module_system.html.

2004-01-21 07:25:53 +00:00

reviews.html

…

todo.html

Add an option `--no-inline-builtins', which causes builtins to

2003-01-30 05:59:30 +00:00

trailing.html

…

type_class_transformation.html

Undo Fergus's recent addition of a request for a pointer to the

2004-03-01 04:24:15 +00:00

TYPES

…

upgrade_boehm_gc.html

Remove an unnecessary step from the process.

2003-10-28 09:04:20 +00:00

work_in_progress.html

Move toward the proposed structures for representing type class information at

2003-10-23 02:02:45 +00:00