My view on this is that Staffan is definitively correct, and that Mark's time/energy is much better directed at code matters.
This is not merely an academic issue; the syntax diagrams conflict with reality (and the blanket rule). How is this any less important than a typo in the method name in a syntax diagram? Someone with the available cycles should jump on Mark's offer of a fast-track to Committer status, and pick this up. -Chip- On 2/16/2013 12:14 Staffan Tylen said: > Quite some time ago I made some comments on the use of place-holding > commas in parameter lists and the way they are documented. I didn't > receive any reaction on this at the time (maybe something went wrong > with my posting) and I forgot about it until now when I looked at the > following description of the createStaticText method: > > > >>--createStaticText(-+------+--x-,--y-+------+-+------+-+----------+-+--------+-)->< > +-id-,-+ +-,-cx-+ +-,-cy-+ +-,-style--+ > +-,-text-+ > > This in my opinion is a good example that illustrates the confusion > that can be created when reading it. > > <snip> > > Based on this I am of the opinion that the parameter list is better > documented like this: > > > >>--createStaticText(-+----+-,-x-,-y-,-+----+-,-+----+-,-+-------+-,-+------+-)->< > +-id-+ +-cx-+ +-cy-+ +-style-+ > +-text-+ > > Here there are no optional commas, which is the norm when writing a > parameter list. There are exceptions to this, like the ListView 'add' > method, which allows for a variable number of commas, but such > exceptions are few and the variable comma seems to be documented > "correctly". > > What's the general view on this? > > Staffan > > > > > > ------------------------------------------------------------------------------ > The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, > is your hub for all things parallel software development, from weekly thought > leadership blogs to news, videos, case studies, tutorials, tech docs, > whitepapers, evaluation guides, and opinion stories. Check out the most > recent posts - join the conversation now. http://goparallel.sourceforge.net/ > > > > _______________________________________________ > Oorexx-users mailing list > Oorexx-users@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/oorexx-users > ------------------------------------------------------------------------------ The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials, tech docs, whitepapers, evaluation guides, and opinion stories. Check out the most recent posts - join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ Oorexx-users mailing list Oorexx-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/oorexx-users
