Skip to content

Commit 95cb12a

Browse files
author
Seeker04
committed
Added note on not always listing all call modes in documentation comments
1 parent d83373a commit 95cb12a

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/development_guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ Our usage:
8585
Rules:
8686

8787
* All predicates _must_ have [SWI-Prolog style structured comments](https://www.swi-prolog.org/pldoc/doc_for?object=section(%27packages/pldoc.html%27)) that shows determinism, arity, and type & mode indicators for arguments.
88+
* We take some liberty here: if a predicate can be run in several modes, we usually don't list them all, only the most intended and used invocation
8889
* Hard to understand code _should_ be commented to show its intent.
8990
* All new predicates _should_ have unit tests. Both positive (success) and negative (failure) cases if applicable.
9091
* Global variables and dynamic predicates _must_ have documentation comments explaining their purpose.

0 commit comments

Comments
 (0)