Refactor and improve specific modules documentation.

This commit is contained in:
Dominik Pantůček 2023-04-23 18:32:02 +02:00
parent 42d47b3efe
commit 35a20a8a1a
2 changed files with 51 additions and 49 deletions

View file

@ -11,37 +11,6 @@ Functional Modules
These modules are specific to this project and their generic usage is These modules are specific to this project and their generic usage is
questionable. 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 Payments Processor
### Members Info Printer ### Members Info Printer
@ -50,20 +19,3 @@ Loads configuration from ```(*etc-hackerbase*)``` file.
### Web Static ### 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.

View file

@ -2,7 +2,8 @@ Organization Specification
========================== ==========================
The specification of how the organization handles membership fees is 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 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 Determines how many months the member can be suspended before any
action is required. 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.