brmlab/hackerbase
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Refactor and improve specific modules documentation.

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

48
doc/modules.md
View file

@ -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.