Default type paremeters in generated documentation

[Paco Soberón]

Hi,

I've noticed that generated documentation tries to "normalize" syntactic abbrevations, but when doing so, it includes default type parameters. For example, the following source code:

shared Integer count({Boolean*} values) {
   ...
}

generates this documentation:

shared Integer count(Iterable<Boolean,Null> values)

Wouldn't it be clearer if it leaves out the default type parameter? I think this would be more readable:

shared Integer count(Iterable<Boolean> values)

Regards.

[Tomáš Hradec]

Hi

Thanks for noticing. This bug [1] is fixed already, but documentation wasn't published again.

[1] https://github.com/ceylon/ceylon-compiler/issues/1094

Cheers

Tomas

2013/3/20 Paco Soberón <unra...@gmail.com>

--
You received this message because you are subscribed to the Google Groups "ceylon-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ceylon-dev+...@googlegroups.com.
To post to this group, send email to ceylo...@googlegroups.com.
Visit this group at http://groups.google.com/group/ceylon-dev?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Paco Soberón]

Hi,

Would it be possible to re-publish the documentation using syntactic abbreviations? I'm trying to show the virtues of Ceylon to some colleagues, but the API seems a bit scary in methods like "entries()".

Thanks in advance,

    Paco

El 20/03/13 14:58, Tomáš Hradec escribió:

[Stephane Epardaud]

It's not trivial ATM, because the M6 compiler does not accept M5-compiled files, and the language module includes a ton of those, so we can't generate doc for M5 using an M6 compiler. And if I document the M6 API then users won't find that very useful as it's not what we released.

Stéphane Épardaud