Mailing List Archive: 49091 messages
  • Home
  • Script library
  • AltME Archive
  • Mailing list
  • Articles Index
  • Site search

[REBOL] Who is that grouch? -or- Fun with functions! Re:(14)

From: joel:neely:fedex at: 6-Oct-2000 10:24

Yes, Allen (and Ladislav)... [allen--rebolforces--com] wrote:
> Normally I use the 'tick to indicate a REBOL word / function, but I notice > that HELP and feedback use full capitalisation instead. Maybe we should > adopt that? >
...I think we're all struggling to overcome the typographic limitations of plain text email (and, please, nobody offer html-ized email as the answer!) to clarify our REBOL fragments, snippets, and quotations. I'll be quite happy to try to abide by a common convention in the interest of readability. Do you think that the HELP convention, as in:
>> help append
USAGE: APPEND series value /only DESCRIPTION: Appends a value to the tail of a series and returns the series head. APPEND is a function value. ARGUMENTS: series -- (Type: series port) value -- (Type: any) REFINEMENTS: /only -- Appends a block value as a block is sufficient, or do we need a bit more decoration? E.g., in the USAGE: section, APPEND indicates the name, but in the DESCRIPTION section APPEND clearly is describing the (standard global) value bound to that name. In addition, in the REFINEMENTS: section, "/only" is uncaptialized. Of course, I dislike red tape as much as the next person! Maybe we could start with a minimum of convention, and only add features as needed for clarification? -jn- -- ; Joel Neely [joel--neely--fedex--com] 901-263-4460 38017/HKA/9677 REBOL [] print to-string debase decompress #{ 789C0BCE0BAB4A7176CA48CAB53448740FABF474F3720BCC B6F4F574CFC888342AC949CE74B50500E1710C0C24000000}