OpenEuphoria

Question about doc style

• Posted by irv Sep 06, 2019
• 901 views

I notice that in many (most?) of the docs, an example is given like the following:

include console.e  
namespace console  
public procedure display(object data_in, object args = 1,... 

First of all, include console.e won't work in a program. It needs to be std/console.e. So a new programmer could be confused.

Secondly, "we" know that the second line is just reminding us that a namespace has already been assigned to std/console.e (don't we?). It isn't required to be there unless there's a specific reason: reasignment. So a new programmer could be confused, or just doing extra typing for nothing.

Thirdly, in the demo following, nowhere is console:display() called. Just display(). Further confusion, I think.

Perhaps there's a better, less confusing way to do this.