Commit c93041a5 authored by Jose A. Lopes's avatar Jose A. Lopes
Browse files

Fix module documentation



Fix 'HsConstants' module documentation to warn about proper module
usage.
Signed-off-by: default avatarJose A. Lopes <jabolopes@google.com>
Reviewed-by: default avatarKlaus Aehlig <aehlig@google.com>
parent 4651c69f
......@@ -4,6 +4,14 @@ This is a transitional module complementary to 'Ganeti.Constants'. It
is intended to contain the Haskell constants that are meant to be
generated in Python.
Do not write any definitions in this file other than constants. Do
not even write helper functions. The definitions in this module are
automatically stripped to build the Makefile.am target
'ListConstants.hs'. If there are helper functions in this module,
they will also be dragged and it will cause compilation to fail.
Therefore, all helper functions should go to a separate module and
imported.
-}
{-
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment