Maybe the comment style is bikeshedding, but definitely the placement of comments always starting on the leftmost column affects the ability to read the code for me.

-Steve

P.S. aren't all style guide discussions some form of bikeshedding?




>________________________________
>From: David Simcha <dsimcha at gmail.com>
>To: Discuss the phobos library for D <phobos at puremagic.com>
>Sent: Thursday, March 31, 2011 11:57 AM
>Subject: Re: [phobos] Initial Phobos style guide proposal
>
>
>In general I think this discussion is devolving into silly bikeshed issues.? I find that the stuff being discussed here doesn't have much effect on readability (I can read code in lots of styles) but is annoying to have to remember when writing code.?
>
>I'm fully on board with specifying anything that affects the public API.? For private implementation details, though, I think inconsistency across modules is the lesser of two evils compared to fighting all these stupid bikeshed wars over what the One True Way will be for Phobos.? I think the most important rule is to just be consistent within a module.? When maintaining a module written by someone else, try to adapt your style to what you see.? When writing a new module, just use common sense and don't do anything horribly unreadable.
>
>
>On Thu, Mar 31, 2011 at 11:37 AM, Andrei Alexandrescu <andrei at erdani.com> wrote:
>
>On 3/31/11 10:13 AM, Jacob Carlborg wrote:
>>
>>I sugest people start using an editor that handles the *'s automatically.
>>>
>>
Mine does, but in past discussions people have complained about overly specific requirements for editor capabilities.
>>
>>Andrei
>>
>>_______________________________________________
>>phobos mailing list
>>phobos at puremagic.com
>>http://lists.puremagic.com/mailman/listinfo/phobos
>>
>
>_______________________________________________
>phobos mailing list
>phobos at puremagic.com
>http://lists.puremagic.com/mailman/listinfo/phobos
>
>



-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puremagic.com/pipermail/phobos/attachments/20110331/0ce19ed2/attachment.html>

On Thu, Mar 31, 2011 at 12:10 PM, Steve Schveighoffer

> P.S. aren't all style guide discussions some form of bikeshedding?
>
>
Yes, but this is bikeshedding implementation details, not even public API. Also, we're spending tons of time on it.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puremagic.com/pipermail/phobos/attachments/20110331/b5bc4999/attachment.html>

On 2011-03-31 09:10, Steve Schveighoffer wrote:
> Maybe the comment style is bikeshedding, but definitely the placement of comments always starting on the leftmost column affects the ability to read the code for me.

I would point out that the example code needs to go all the way to the left, otherwise the examples get indented in the generated docs. However, I agree that the ddoc comments themselves not being indented is annoying.

- Jonathan M Davis

On 3/31/11 12:25 PM, Jonathan M Davis wrote:
> On 2011-03-31 09:10, Steve Schveighoffer wrote:
>> Maybe the comment style is bikeshedding, but definitely the placement of comments always starting on the leftmost column affects the ability to read the code for me.
>
> I would point out that the example code needs to go all the way to the left, otherwise the examples get indented in the generated docs. However, I agree that the ddoc comments themselves not being indented is annoying.

Yah, forgot about that argument. I'm not sure where this leaves us.

Andrei

On 3/31/2011 10:55 AM, Andrei Alexandrescu wrote:
> On 3/31/11 12:25 PM, Jonathan M Davis wrote:
>> On 2011-03-31 09:10, Steve Schveighoffer wrote:
>>> Maybe the comment style is bikeshedding, but definitely the placement of comments always starting on the leftmost column affects the ability to read the code for me.
>>
>> I would point out that the example code needs to go all the way to the left, otherwise the examples get indented in the generated docs. However, I agree that the ddoc comments themselves not being indented is annoying.
> 
> Yah, forgot about that argument. I'm not sure where this leaves us.
> 
> Andrei

Improving ddoc.  You guys seem to be treating it as some sort of unchangable thing.  If it doesn't behave the way we need it to, pull up the code and whack it a bit.

On 2011-03-31 10:57, Brad Roberts wrote:
> On 3/31/2011 10:55 AM, Andrei Alexandrescu wrote:
> > On 3/31/11 12:25 PM, Jonathan M Davis wrote:
> >> On 2011-03-31 09:10, Steve Schveighoffer wrote:
> >>> Maybe the comment style is bikeshedding, but definitely the placement of comments always starting on the leftmost column affects the ability to read the code for me.
> >> 
> >> I would point out that the example code needs to go all the way to the left, otherwise the examples get indented in the generated docs. However, I agree that the ddoc comments themselves not being indented is annoying.
> > 
> > Yah, forgot about that argument. I'm not sure where this leaves us.
> > 
> > Andrei
> 
> Improving ddoc.  You guys seem to be treating it as some sort of unchangable thing.  If it doesn't behave the way we need it to, pull up the code and whack it a bit.

What do you think we are? Software developers? ;)

- Jonathan M Davis