diff --git a/doc/modules.md b/doc/modules.md index 5dae9c5..512264f 100644 --- a/doc/modules.md +++ b/doc/modules.md @@ -11,37 +11,6 @@ Functional Modules These modules are specific to this project and their generic usage is questionable. -### Configuration - - (import configuration) - -The exact behavior of some algorithms in other modules can be changed -via configuration parameters in this global configuration module. - -This module also handles configuration file loading. - - (*etc-hackerbase* path) - -* ```path``` - path to file with configuration - -Used by ```load-configuration!``` to load the system-specific default -configuration values. - -*members-directory* - -*apikeys-file* - -*jendasap-checked* - -*bank-dir* - -*email-from* - - (load-configuration!) - -Loads configuration from ```(*etc-hackerbase*)``` file. - - ### Members Payments Processor ### Members Info Printer @@ -50,20 +19,3 @@ Loads configuration from ```(*etc-hackerbase*)``` file. ### Web Static -Specific Support Modules ------------------------- - -### Primes - -A very simple module for generating and checking 4-digit prime numbers. - - (is-4digit-prime? n) - -* ```n``` - a number - -Returns true if the given number ```n``` has four digits and it is a -prime number. - - (gen-all-4digit-primes) - -Returns a list of all 4-digit prime numbers. diff --git a/doc/specification.md b/doc/specification.md index 6dd544e..08765b9 100644 --- a/doc/specification.md +++ b/doc/specification.md @@ -2,7 +2,8 @@ Organization Specification ========================== The specification of how the organization handles membership fees is -completely wrapped inside the specification module. +completely wrapped inside the specification module. Some other +organization-specific modules are also included here. Modules ------- @@ -29,3 +30,52 @@ A period lookup-table for CZK/EUR conversion. Used by the Determines how many months the member can be suspended before any action is required. + +### Primes + + (import primes) + +A very simple module for generating and checking 4-digit prime numbers. + + (is-4digit-prime? n) + +* ```n``` - a number + +Returns true if the given number ```n``` has four digits and it is a +prime number. + + (gen-all-4digit-primes) + +Returns a list of all 4-digit prime numbers. + +### Configuration + + (import configuration) + +The exact behavior of some algorithms in other modules can be changed +via configuration parameters in this global configuration module. + +This module also handles configuration file loading. + + (*etc-hackerbase* path) + +* ```path``` - path to file with configuration + +Used by ```load-configuration!``` to load the system-specific default +configuration values. + +*members-directory* + +*apikeys-file* + +*jendasap-checked* + +*bank-dir* + +*email-from* + +*summary-mailto* + + (load-configuration!) + +Loads configuration from ```(*etc-hackerbase*)``` file.