Smalltalk › Squeak › Squeak - Dev

[DOCS] http://bugs.squeak.org/view.php?id=7557

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

5 messages Options

Casey Ransberger-2

[DOCS] http://bugs.squeak.org/view.php?id=7557

Figured I'd give it a try:)

I think it may be worth filing a few "doc" bugs to get a nice little backlog going. If any of you can think of anything you'd personally like to see better docs for, don't be shy about filing a bug:)

Once we have a nice little pile of doc bugs, we can start looking for a workflow. Pick stuff off. Sound like a good idea?

--
Casey Ransberger

Michael Haupt-3

Re: [DOCS] http://bugs.squeak.org/view.php?id=7557

Hi Casey,

On Fri, Aug 27, 2010 at 8:22 AM, Casey Ransberger
<[hidden email]> wrote:
> Figured I'd give it a try:)

this one is on the scale of a larger tutorial-style piece, right?

> I think it may be worth filing a few "doc" bugs to get a nice little backlog
> going. If any of you can think of anything you'd personally like to see
> better docs for, don't be shy about filing a bug:)

Even if it's just a missing or seemingly outdated class comment. We
consider this a bug. :-)

> Once we have a nice little pile of doc bugs, we can start looking for a
> workflow. Pick stuff off. Sound like a good idea?

Absolutely.

Is there a way of getting e-mail or RSS notifications when new bugs of
a certain category are filed?

Best,

Michael,
Mantis noob ;-)

Casey Ransberger-2

Re: [DOCS] http://bugs.squeak.org/view.php?id=7557

I'm pretty new to it too. I have a feeling that it's probably pretty limited.

Kinda jealous of:

http://tracker.squeakland.org/secure/Dashboard.jspa

I was on a team that did a trial of Jira awhile back. It was really powerful, but it did have a learning curve on it. Still, nice front page feed of what Bert just did/etc, friendly RSS icon right there.

On Thu, Aug 26, 2010 at 11:29 PM, Michael Haupt <[hidden email]> wrote:

Hi Casey,

On Fri, Aug 27, 2010 at 8:22 AM, Casey Ransberger
<[hidden email]> wrote:
> Figured I'd give it a try:)

this one is on the scale of a larger tutorial-style piece, right?

> I think it may be worth filing a few "doc" bugs to get a nice little backlog
> going. If any of you can think of anything you'd personally like to see
> better docs for, don't be shy about filing a bug:)

Even if it's just a missing or seemingly outdated class comment. We
consider this a bug. :-)

> Once we have a nice little pile of doc bugs, we can start looking for a
> workflow. Pick stuff off. Sound like a good idea?

Absolutely.

Is there a way of getting e-mail or RSS notifications when new bugs of
a certain category are filed?

Best,

Michael,
Mantis noob ;-)

--
Casey Ransberger

Casey Ransberger-2

Re: [DOCS] http://bugs.squeak.org/view.php?id=7557

In reply to this post by Michael Haupt-3

Inline.

On Thu, Aug 26, 2010 at 11:29 PM, Michael Haupt <[hidden email]> wrote:

this one is on the scale of a larger tutorial-style piece, right?

Yeah, it's a big one. No need to fix it right away. But eventually:)

Even if it's just a missing or seemingly outdated class comment. We
consider this a bug. :-)

Word! In fact, I'd consider any non-trivial method without a short comment a bug. Not a bug: accessor methods without comments, for example:)

Best,

Michael,

--
Casey Ransberger

Hannes Hirzel

Re: [DOCS] http://bugs.squeak.org/view.php?id=7557

Great, Casey

I like the documentation bug you have filed
http://bugs.squeak.org/view.php?id=7557

I support what you write there.

But in addition - we should not feel shy to post easy to fix things as well.

--Hannes

On 8/27/10, Casey Ransberger <[hidden email]> wrote:

> Inline.
>
> On Thu, Aug 26, 2010 at 11:29 PM, Michael Haupt <[hidden email]> wrote:
>
>> this one is on the scale of a larger tutorial-style piece, right?
>>
>> Yeah, it's a big one. No need to fix it right away. But eventually:)
>
>
>> Even if it's just a missing or seemingly outdated class comment. We
>> consider this a bug. :-)
>>
>
> Word! In fact, I'd consider any non-trivial method without a short comment a
> bug. Not a bug: accessor methods without comments, for example:)
>
>
>> Best,
>>
>> Michael,
>>
>>
> --
> Casey Ransberger
>