General discussion about the Scala programming language

Pedro Furlanetto | 1 Apr 2011 01:00

Re: scaladoc: separating members

Approved!

On Thu, Mar 31, 2011 at 7:00 PM, Daniel Sobral <dcsobral <at> gmail.com> wrote:
> +1
>
> On Thu, Mar 31, 2011 at 17:50, Paul Phillips <paulp <at> improving.org> wrote:
>>
>> Attached is a screenshot showing the impact of a scaladoc change I just
>> checked in.  Like I said in the commit message, I can't even imagine not
>> wanting to do this, but since I figured out at some point that everyone
>> doesn't see the world quite the way I do, I submit it for your approval.
>
>
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.
>

headers

Donna Malayeri | 1 Apr 2011 03:35

Re: scaladoc: separating members

I like it!

headers

Archontophoenix Quar | 1 Apr 2011 05:07

Re: a spruced-up scaladoc

Ooh, pretty! I like the fonts in number 5.

However, I'd like it better if the icons for classes and traits were more visually distinct. Those little white-on-colored background t's and c's look awfully similar from a distance. Perhaps different colors for the backgrounds? And (as long as I'm on Santa's knee) maybe yet *another* color to distinguish concrete from abstract classes? When I'm exploring a library, often the first thing I do is try to figure out which types are concrete and which are abstract.

A

On Thu, Mar 31, 2011 at 11:09 AM, Donna Malayeri <lindydonna <at> gmail.com> wrote:

With the help of Rüdiger Keller, I've created some modifications to the colors and layout of Scaladoc. I have a few versions available:

CSS changes, but no color changes:
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc2/

Minor additional color changes:
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc3/

Lots more color changes:
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc4/

Minor font change and sharper object/class/trait icons for the left pane
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc5/

I personally prefer the last of these, but we all welcome your feedback! What is good, what is bad, and why?

thanks,
Donna

headers

Randall R Schulz | 1 Apr 2011 07:33

Re: Re: a spruced-up scaladoc

On Thursday March 31 2011, Rüdiger Keller wrote:
> Hi Donna,
>
> nice job putting up all these versions of Scaladoc!
>
> Just for kicks, I attached an image to my mail that shows a variation
> of the title bar. The type name is underlined, because I though it
> could be used as a link to the companion object, if there is one.
>
> Everyone, please feel free to comment on this one, too.
>
> Regards,
> Rüdiger

Please tell me you're not forcing a serifed font. Let the user choose 
what their default font type is, please.

Randall Schulz

headers

Donna Malayeri | 1 Apr 2011 08:48

Re: a spruced-up scaladoc

I am planning on doing different colors for traits and classes, so that's already on the to-do list. :)

Concrete vs. abstract classes is a bit more tricky, since that would require more changes to the HTML output. In Scala, you often see traits rather than abstract classes, so hopefully this isn't as important as compared to javadoc.

Donna

On Apr 1, 2011, at 5:07 AM, Archontophoenix Quar wrote:

Ooh, pretty! I like the fonts in number 5.

However, I'd like it better if the icons for classes and traits were more visually distinct. Those little white-on-colored background t's and c's look awfully similar from a distance. Perhaps different colors for the backgrounds? And (as long as I'm on Santa's knee) maybe yet *another* color to distinguish concrete from abstract classes? When I'm exploring a library, often the first thing I do is try to figure out which types are concrete and which are abstract.

A

On Thu, Mar 31, 2011 at 11:09 AM, Donna Malayeri <lindydonna <at> gmail.com> wrote:
With the help of Rüdiger Keller, I've created some modifications to the colors and layout of Scaladoc. I have a few versions available:

CSS changes, but no color changes:
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc2/

Minor additional color changes:
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc3/

Lots more color changes:
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc4/

Minor font change and sharper object/class/trait icons for the left pane
http://lamp.epfl.ch/~malayeri/scaladoc-versions/scaladoc5/

I personally prefer the last of these, but we all welcome your feedback! What is good, what is bad, and why?

thanks,
Donna

headers

Donna Malayeri | 1 Apr 2011 08:58

Re: Re: a spruced-up scaladoc

That was just a screenshot based on one of my proposed CSS changes. My plan is to use the font style that people
like most, which seems to be the sans-serif font right now. It's not so easy to allow users to dynamically
change the font style, so someone who wants a different default would have to change their CSS file locally.

My thought was that perhaps people would prefer the serif font, as that is how it's done in Javadoc.

Donna

On Apr 1, 2011, at 7:33 AM, Randall R Schulz wrote:
> Please tell me you're not forcing a serifed font. Let the user choose 
> what their default font type is, please.

headers

Nate Nystrom | 1 Apr 2011 09:20

Re: Re: a spruced-up scaladoc

Donna,

It would be nice to ensure that there's enough semantic information in the CSS classes and ids that someone
could easily write  a Greasemonkey script to change the default rendering.  For instance, abstract and
concrete types should have different CSS classes.

Nate

On Apr 1, 2011, at 08:58 , Donna Malayeri wrote:

> That was just a screenshot based on one of my proposed CSS changes. My plan is to use the font style that
people like most, which seems to be the sans-serif font right now. It's not so easy to allow users to
dynamically change the font style, so someone who wants a different default would have to change their CSS
file locally.
> 
> My thought was that perhaps people would prefer the serif font, as that is how it's done in Javadoc.
> 
> Donna
> 
> On Apr 1, 2011, at 7:33 AM, Randall R Schulz wrote:
>> Please tell me you're not forcing a serifed font. Let the user choose 
>> what their default font type is, please.
>

headers

Donna Malayeri | 1 Apr 2011 09:32

Re: Re: a spruced-up scaladoc

Agreed. For traits vs. classes, this is quite easy, but I can file an enhancement ticket for abstract types
in general. 

Donna

On Apr 1, 2011, at 9:20 AM, Nate Nystrom wrote:
> It would be nice to ensure that there's enough semantic information in the CSS classes and ids that someone
could easily write  a Greasemonkey script to change the default rendering.  For instance, abstract and
concrete types should have different CSS classes.

headers

Philippe Lhoste | 1 Apr 2011 11:34

Re: a spruced-up scaladoc

On 01/04/2011 08:58, Donna Malayeri wrote:
> My thought was that perhaps people would prefer the serif font, as that is how it's done in Javadoc.

Where do you see that? In http://download.oracle.com/javase/6/docs/api/ pages, there is no 
font specifications except on some navigation items, and these are the classical 
Helvetica, Arial, sans-serif trio.

> On Apr 1, 2011, at 7:33 AM, Randall R Schulz wrote:
>> Please tell me you're not forcing a serifed font. Let the user choose
>> what their default font type is, please.

You wrote:
 > It's not so easy to allow users to dynamically change the font style

I don't think that's what Randall wrote. If you don't specify a font, the browser will 
pick either the default, or the fonts the user chose in its preferences / options.

Of course, Stylish, Greasemonly, user stylesheets and other facilities (depending on 
browser) can allow to customize these pages, but I doubt many users will make such change.

--

-- 
Philippe Lhoste
--  (near) Paris -- France
--  http://Phi.Lho.free.fr
--  --  --  --  --  --  --  --  --  --  --  --  --  --

headers

Luc Duponcheel | 1 Apr 2011 12:05

I must be blind

Hello All,

why does this REPL session complain

scala> class Test {
     | type P[X]
     | trait Seg[W, Y, Z]
     | sealed trait Seq[Seg[_, _, _], Y]
     | case class PushPrompt[Y](p: Prompt[Y], seq: Seq[Seg, Y]) extends Seq[Seg, Y]
     | case class SubSeq[Seg[_, _, _], Y, Z](val open: Seq[Seg, Z] => Seq[Seg, Y]) {
     |   def splitSeq: Prompt[Z] => Seq[Seg, Y] => (SubSeq[Seg, Y, Z], Seq[Seg, Z]) =
     |    p => {
     |     case PushPrompt(q, sep) => error("tbd")
     |    }
     |   }
     | }
<console>:18: error: constructor cannot be instantiated to expected type;
found   : Test.this.PushPrompt[Y(in class PushPrompt)]
required: Test.this.Seq[Seg,Y(in class SubSeq)]
           case PushPrompt(q, sep) => error("tbd")

while this one does not

scala> class Test {
     | type P[X]
     | sealed trait Seq[Y]
     | case class PushPrompt[Y](p: Prompt[Y], seq: Seq[Y]) extends Seq[Y]
     | case class SubSeq[Y, Z](open: Seq[Z] => Seq[Y]) {
     |   def splitSeq: Prompt[Z] => Seq[Y] => (SubSeq[Y, Z], Seq[Z]) =
     |    p => {
     |     case PushPrompt(q, sep) => error("tbd")
     |    }
     |   }
     | }
defined class Test

(the only difference is the trait Seg)

Luc

--
   __~O
-\ <,
(*)/ (*)

reality goes far beyond imagination

Mon	Tue	Wed	Thu	Fri	Sat	Sun

				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30

119	May 2013
305	April 2013
296	March 2013
280	February 2013
350	January 2013
274	December 2012
116	November 2012
334	October 2012
108	September 2012
149	August 2012
250	July 2012
134	June 2012
284	May 2012
270	April 2012
490	March 2012
263	February 2012
92	January 2012
166	December 2011
114	November 2011
276	October 2011
159	September 2011
296	August 2011
264	July 2011
229	June 2011
465	May 2011
333	April 2011
364	March 2011
209	February 2011
135	January 2011
390	December 2010
163	November 2010
163	October 2010
368	September 2010
204	August 2010
280	July 2010
388	June 2010
333	May 2010
267	April 2010
205	March 2010
230	February 2010
271	January 2010
222	December 2009
404	November 2009
405	October 2009
475	September 2009
321	August 2009
381	July 2009
279	June 2009
347	May 2009
457	April 2009
371	March 2009
315	February 2009
348	January 2009
191	December 2008
206	November 2008
333	October 2008
389	September 2008
394	August 2008
367	July 2008
291	June 2008
526	May 2008
340	April 2008
380	March 2008
649	February 2008
1002	January 2008
903	December 2007
344	November 2007
684	October 2007
356	September 2007
546	August 2007
450	July 2007
401	June 2007
538	May 2007
250	April 2007
530	March 2007
537	February 2007
532	January 2007
319	December 2006
193	November 2006
113	October 2006
153	September 2006
112	August 2006
140	July 2006
82	June 2006
50	May 2006
148	April 2006
91	March 2006
102	February 2006
113	January 2006
37	December 2005
90	November 2005
105	October 2005
74	September 2005
130	August 2005
38	July 2005
59	June 2005
42	May 2005
62	April 2005
57	March 2005
25	February 2005
23	January 2005
11	December 2004
46	November 2004
20	October 2004
21	September 2004
34	August 2004
53	July 2004
22	June 2004
32	May 2004
41	April 2004
48	March 2004
67	February 2004
41	January 2004
1	December 2003