Skip to content

Commit ea37782

Browse files
Update TO-DO.
FossilOrigin-Name: 4674f5be3863d3d5588df4ee04ca7b23a6b79449604a3a6490c414d2461ebd40
1 parent 00708e0 commit ea37782

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

TO-DO.adoc

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Solo Forth TO-DO
22
:author: Marcos Cruz (programandala.net)
3-
:revdate: 2020-10-05
3+
:revdate: 2020-10-06
44

55
// This file is part of Solo Forth
66
// http://programandala.net/en.program.solo_forth.html
@@ -952,6 +952,29 @@ Improve tab control.
952952
// Documentation {{{1
953953
== Documentation
954954

955+
=== 2021-01-06
956+
957+
Make the documentation of variables, constants, etc., coherent with
958+
other types of words. Instead of this:
959+
960+
____
961+
myword ( -- a )
962+
963+
A `variable`. _a_ is the address of ...
964+
____
965+
966+
Write this:
967+
968+
____
969+
myword ( -- a )
970+
971+
Return the address _a_ of ...
972+
973+
``myword`` is a `variable`.
974+
____
975+
976+
I.e. first describe the action of the word in imperative.
977+
955978
=== 2021-01-05
956979

957980
Improve wording of "return it _fid_".

0 commit comments

Comments
 (0)