about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorDarren Bane <darren.bane@gmail.com>2020-05-28 00:45:44 +0100
committerDarren Bane <darren.bane@gmail.com>2020-05-28 00:45:44 +0100
commitf412f2fbcc1ba164bd116204e01808c83f0d5aec (patch)
tree206d281f6ea7ba53bacb93f1dd06f3c857e6eed5 /doc
parentb8168bbb7ae6063fa802386926ef13126ba11ab7 (diff)
downloadlsp-f412f2fbcc1ba164bd116204e01808c83f0d5aec.tar.gz
Minor doc edits
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile2
-rw-r--r--doc/breaking_rules.md8
-rw-r--r--doc/refs4
3 files changed, 11 insertions, 3 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 9cd37e5..2a8f5cc 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -20,4 +20,4 @@ refs.i: refs
 
 .PHONY: clean
 clean:
-	$(RM) breaking_rules.pdf
+	$(RM) breaking_rules.pdf breaking_rules.html
diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md
index 1a4b451..a20bdac 100644
--- a/doc/breaking_rules.md
+++ b/doc/breaking_rules.md
@@ -156,7 +156,11 @@ However, some of this documentation is better in the source code:
 
 * The summary of functions should be taken care of by having the public functions and classes commented.
 * The formal requirement for function behaviour is better done with contracts.
-  Tables with Simple English are still a good idea for initial work.
+  Tables with Basic English
+\.[
+basic english
+\.]
+  are still a good idea for initial work.
 
 ### UI
 
@@ -166,7 +170,7 @@ The following can be added as sections to the README:
 * Task hierarchy
 
 And a proper software requirements spec should be written filling in any blanks that the man pages leave.  
-The specification of input and output variables is best left at the level of tables and Simple English again.
+The specification of input and output variables is best left at the level of tables and Basic English again.
 
 ## Testing
 
diff --git a/doc/refs b/doc/refs
index 2deb994..9eeca05 100644
--- a/doc/refs
+++ b/doc/refs
@@ -1024,3 +1024,7 @@
 %A Russ Cox
 %T How to Write a Plan 9 Manual Page
 %O available: http://www.vitanuova.com/inferno/papers/manhow.pdf [accessed 27 May 2020]
+
+%T Basic English
+%B Wikipedia
+%O available: https://en.wikipedia.org/wiki/Basic_English [accessed 28 May 2020]