durexforth icon indicating copy to clipboard operation
durexforth copied to clipboard

Published 20 hours ago • verified publisher icon jkotlinski

Undocumented words

Open burnsauce opened this issue 5 years ago • 5 comments

Several words remain undocumented:

  • ~~rvs~~
  • ~~>dfa~~
  • ~~openw~~
  • ~~closew~~

These words are probably "private" but unable to be hidden due to dependencies:

format.fs:

  • ~~curr~~
  • ~~end~~ asm.fs:
  • ~~1mi~~
  • ~~2mi~~
  • ~~3mi~~
  • ~~23mi~~

The following words deserve documentation. CREATE/DOES> should probably be fleshed out in the tutorial so that the code of DODOES can be explained in the Word Anatomy section of the manual.

BRANCH and 0BRANCH are useful for debugging purposes (SEE) and should also be demonstrated in the Word Anatomy section with an appropriate example.

base.fs / asm:

  • branch
  • 0branch
  • dodoes

burnsauce avatar Nov 05 '20 19:11 burnsauce

Fixed RVS, OPENW, CLOSEW, >DFA

jkotlinski avatar May 14 '21 21:05 jkotlinski

Fixed 1MI 2MI 23MI 3MI

jkotlinski avatar Jan 02 '22 20:01 jkotlinski

Fixed CURR, END

jkotlinski avatar Jan 02 '22 23:01 jkotlinski

About DODOES, BRANCH, 0BRANCH, I think it makes sense to keep those visible. DODOES for debugging purposes (SEE). BRANCH, 0BRANCH have potential reuse value.

The task to document these words remains. Also CREATE + DOES> deserve much more thorough explanation, right now it just defers to Starting Forth. It would make sense if CREATE/DOES>/DODOES words had a section in "Word Anatomy" chapter.

jkotlinski avatar Jan 02 '22 23:01 jkotlinski

OK, SEE is now removed and so it makes more sense to hide DODOES -- done in c156dacbada9944993a1afa1dc55de4c57cad343

jkotlinski avatar Jan 08 '22 20:01 jkotlinski