Skip to main content



      Home
Home » Eclipse Projects » Eclipse Platform » Where do I report documentation errors?
Where do I report documentation errors? [message #296001] Tue, 13 December 2005 15:34 Go to next message
Eclipse UserFriend
Originally posted by: no.offline.contact.please.nospam.com

I've found a rather odd phrasing in the Help for Eclipse 3.1.1. The title of
the page is "Message Bundles in 3.1". The first paragraph starts:

"Standard Java ResourceBundles have quite inefficient space characteristics.
Since a running Eclipse tends to have many externalized messages we have
implemented a new message bundle _story_ [emphasis added] to be used in
Eclipse...."

The word 'story' doesn't feel right although I'm at a loss to know what
should be in its place. (If anyone knows, I'd be interesting in hearing what
word should replace 'story'.)

Assuming that this really is an error that slipped past the proofreaders,
how do I bring this to the attention of the technical writers so that it can
be fixed in some future version of Eclipse? I assume that there is an
appropriate way to report things like this....

--
Rhino
Re: Where do I report documentation errors? [message #296005 is a reply to message #296001] Tue, 13 December 2005 16:19 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: sunil_kamath.nohotspammail.com

Rhino <no.offline.contact.please@nospam.com> wrote:
> I've found a rather odd phrasing in the Help for Eclipse 3.1.1. The
> title of the page is "Message Bundles in 3.1". The first paragraph
> starts:
> "Standard Java ResourceBundles have quite inefficient space
> characteristics. Since a running Eclipse tends to have many
> externalized messages we have implemented a new message bundle
> _story_ [emphasis added] to be used in Eclipse...."
>
> The word 'story' doesn't feel right although I'm at a loss to know
> what should be in its place. (If anyone knows, I'd be interesting in
> hearing what word should replace 'story'.)
>

"strategy"?

> Assuming that this really is an error that slipped past the
> proofreaders, how do I bring this to the attention of the technical
> writers so that it can be fixed in some future version of Eclipse? I
> assume that there is an appropriate way to report things like this....

Simply file a bug using bugzilla.

--
Sunil
Re: Where do I report documentation errors? [message #296007 is a reply to message #296001] Tue, 13 December 2005 16:24 Go to previous messageGo to next message
Eclipse UserFriend
implementation? Nope, they say "implemented" 5 words prior, so that
won't work. capability??

bugs.eclipse.org => Bug Reports => Report a new bug => Eclipse =>
Platform, then choose Doc as the Component.

I think at the first link you'll need to sign up for your own bugzilla ID.

I don't find the wording that strange, but if you do, then certainly
report it. My experience is that if someone has a problem with
something, others probably will too. On the other hand, I don't know
that I've ever pleased *everybody* with any decision I've made.

I guess it's just a wishy-washy kind of day.
--
RDS


Rhino wrote:
> I've found a rather odd phrasing in the Help for Eclipse 3.1.1. The title of
> the page is "Message Bundles in 3.1". The first paragraph starts:
>
> "Standard Java ResourceBundles have quite inefficient space characteristics.
> Since a running Eclipse tends to have many externalized messages we have
> implemented a new message bundle _story_ [emphasis added] to be used in
> Eclipse...."
>
> The word 'story' doesn't feel right although I'm at a loss to know what
> should be in its place. (If anyone knows, I'd be interesting in hearing what
> word should replace 'story'.)
>
> Assuming that this really is an error that slipped past the proofreaders,
> how do I bring this to the attention of the technical writers so that it can
> be fixed in some future version of Eclipse? I assume that there is an
> appropriate way to report things like this....
>
Re: Where do I report documentation errors? [message #296017 is a reply to message #296007] Tue, 13 December 2005 17:41 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: no.offline.contact.please.nospam.com

Thank you both for pointing me in the right direction. I've filed a report
with Bugzilla.

Personally, I'm inclined to think Sunil is probably right; it wouldn't be
that hard to misspell 'strategy' as 'story' - would it? Hmm, guess I'm
feeling a little wishy-washy today, too :-)

Rhino

"Randy D. Smith" <randy.d.smith@intel.com> wrote in message
news:dnne6d$gra$1@news.eclipse.org...
> implementation? Nope, they say "implemented" 5 words prior, so that won't
> work. capability??
>
> bugs.eclipse.org => Bug Reports => Report a new bug => Eclipse =>
> Platform, then choose Doc as the Component.
>
> I think at the first link you'll need to sign up for your own bugzilla ID.
>
> I don't find the wording that strange, but if you do, then certainly
> report it. My experience is that if someone has a problem with something,
> others probably will too. On the other hand, I don't know that I've ever
> pleased *everybody* with any decision I've made.
>
> I guess it's just a wishy-washy kind of day.
> --
> RDS
>
>
> Rhino wrote:
>> I've found a rather odd phrasing in the Help for Eclipse 3.1.1. The title
>> of the page is "Message Bundles in 3.1". The first paragraph starts:
>>
>> "Standard Java ResourceBundles have quite inefficient space
>> characteristics. Since a running Eclipse tends to have many externalized
>> messages we have implemented a new message bundle _story_ [emphasis
>> added] to be used in Eclipse...."
>>
>> The word 'story' doesn't feel right although I'm at a loss to know what
>> should be in its place. (If anyone knows, I'd be interesting in hearing
>> what word should replace 'story'.)
>>
>> Assuming that this really is an error that slipped past the proofreaders,
>> how do I bring this to the attention of the technical writers so that it
>> can be fixed in some future version of Eclipse? I assume that there is an
>> appropriate way to report things like this....
>>
Re: Where do I report documentation errors? [message #296076 is a reply to message #296017] Wed, 14 December 2005 13:06 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: no.offline.contact.please.nospam.com

In case anyone is wondering, the bug report has number 120759; I've already
received notification that the bug is fixed as of Eclipse 3.2 M4! The tech
writer replaced 'story' with 'message bundle system'.

Rhino

"Rhino" <no.offline.contact.please@nospam.com> wrote in message
news:dnnilt$n00$1@news.eclipse.org...
> Thank you both for pointing me in the right direction. I've filed a report
> with Bugzilla.
>
> Personally, I'm inclined to think Sunil is probably right; it wouldn't be
> that hard to misspell 'strategy' as 'story' - would it? Hmm, guess I'm
> feeling a little wishy-washy today, too :-)
>
> Rhino
>
> "Randy D. Smith" <randy.d.smith@intel.com> wrote in message
> news:dnne6d$gra$1@news.eclipse.org...
>> implementation? Nope, they say "implemented" 5 words prior, so that won't
>> work. capability??
>>
>> bugs.eclipse.org => Bug Reports => Report a new bug => Eclipse =>
>> Platform, then choose Doc as the Component.
>>
>> I think at the first link you'll need to sign up for your own bugzilla
>> ID.
>>
>> I don't find the wording that strange, but if you do, then certainly
>> report it. My experience is that if someone has a problem with something,
>> others probably will too. On the other hand, I don't know that I've ever
>> pleased *everybody* with any decision I've made.
>>
>> I guess it's just a wishy-washy kind of day.
>> --
>> RDS
>>
>>
>> Rhino wrote:
>>> I've found a rather odd phrasing in the Help for Eclipse 3.1.1. The
>>> title of the page is "Message Bundles in 3.1". The first paragraph
>>> starts:
>>>
>>> "Standard Java ResourceBundles have quite inefficient space
>>> characteristics. Since a running Eclipse tends to have many externalized
>>> messages we have implemented a new message bundle _story_ [emphasis
>>> added] to be used in Eclipse...."
>>>
>>> The word 'story' doesn't feel right although I'm at a loss to know what
>>> should be in its place. (If anyone knows, I'd be interesting in hearing
>>> what word should replace 'story'.)
>>>
>>> Assuming that this really is an error that slipped past the
>>> proofreaders, how do I bring this to the attention of the technical
>>> writers so that it can be fixed in some future version of Eclipse? I
>>> assume that there is an appropriate way to report things like this....
>>>
>
>
Re: Where do I report documentation errors? [message #296133 is a reply to message #296076] Thu, 15 December 2005 09:41 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: automatic.javalobby.org

Good stuff. That's how Eclipse gets better.

In case you're wondering, story is a term that's frequently used with agile development techniques to describe a small piece of functionality that can be implemented in a few days. In much the same way that you might say 'the message bundle functionality', an agile developer might talk of 'the message bundle story' as the work required to make it happen.

It's possible (if not entirely plausible) that this doc was just cut-n-pasted from the notes that were used to help the developer figure out what to do ...

Alex.
Re: Where do I report documentation errors? [message #296156 is a reply to message #296133] Thu, 15 December 2005 18:18 Go to previous messageGo to next message
Eclipse UserFriend
I agree with the comment about how Eclipse gets better. And thanks for
the agile perspective... I've got to admit that I have a propensity to
dislike "movements" that feel that they have to create whole new jargon
when we already have perfectly good jargon... I think I would have
"gotten" OO more quickly in the 80s if they'd abandoned the "send the
object a message" terminology sooner! :-)
--
RDS

Alex Blewitt wrote:
> Good stuff. That's how Eclipse gets better.
>
> In case you're wondering, story is a term that's frequently used with
> agile development techniques to describe a small piece of
> functionality that can be implemented in a few days. In much the same
> way that you might say 'the message bundle functionality', an agile
> developer might talk of 'the message bundle story' as the work
> required to make it happen.
>
> It's possible (if not entirely plausible) that this doc was just
> cut-n-pasted from the notes that were used to help the developer
> figure out what to do ...
>
> Alex.
Re: Where do I report documentation errors? [message #296179 is a reply to message #296156] Fri, 16 December 2005 08:14 Go to previous message
Eclipse UserFriend
Originally posted by: automatic.javalobby.org

No problem. I'm here to leverage my resources towards synergistic information-sharing in the Web 2.0 world.

Alex.
Previous Topic:How to refresh a project workspace using program?
Next Topic:CVS Merge Branches difficulties
Goto Forum:
  


Current Time: Fri Jul 18 17:17:46 EDT 2025

Powered by FUDForum. Page generated in 0.04591 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top