=== Garp3 Coding Conventions ===
Jochem Liem

Throught the years multiple developers have worked on Garp3. Their different coding
conventions and styles make code look inconsistent. This small document
provide guidelines when developing garp3 code. Note that these conventions are
a rather arbitrary choice. Better coding conventions should be discussed and
become normative.


== Variables ==
Do not use underscores but capitalisation: VariableList instead of
Variable_list.

== Functions ==
Use underscores instead of capitalisation: get_variable_scheep instead of
getVariableSheep.

== Documentation ==
Make sure pldoc understands your documentation and does not cause parsing
errors (or warnings). See .plrc to know how to start a pldoc server to show
your documentation. For more on pldoc read:
http://www.swi-prolog.org/packages/pldoc.html

It is extremely useful to use pldoc documentation! It makes sure you document
your code, and it forces you to properly structure your code. Use it!

== .plrc ==

By creating a .plrc file in your homedir with the following contents, you can
start Garp3 with the pldoc documentation server (and automatically start a
browser with the documentation). To start Garp3 use: 'pl -s startup.pl --doc'


% Start the documentation server if started with --doc
start_doc_server :-
    current_prolog_flag(argv, Flags),
    member('--doc', Flags),
    doc_server(_),
    doc_browser.

% Fail
start_doc_server.

:- start_doc_server.