Issue 98349 - Spelling mistake in API (WrapTextMode.THROUGHT)
Summary: Spelling mistake in API (WrapTextMode.THROUGHT)
Status: CONFIRMED
Alias: None
Product: App Dev
Classification: Unclassified
Component: api (show other issues)
Version: 3.3.0 or older (OOo)
Hardware: All All
: P4 Trivial
Target Milestone: ---
Assignee: AOO issues mailing list
QA Contact:
URL: http://svn.services.openoffice.org/op...
Keywords:
Depends on:
Blocks:
 
Reported: 2009-01-22 10:40 UTC by Daniel Darabos
Modified: 2013-02-24 21:08 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Latest Confirmation in: ---
Developer Difficulty: ---


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Daniel Darabos 2009-01-22 10:40:20 UTC
THROUGHT is a common mispelling of THROUGH.

Having misspelled symbol names unnecessarily taxes developers (we have to 
remember _how_ the symbol is misspelled every time we use it) and breaks 
searching by symbols (I searched for THROUGH, but did not find it because I did 
not remember to misspell it).
Comment 1 jsc 2009-01-27 09:51:09 UTC
jsc -> tl: we should correct it in IDL and should support both for compatibility
reasons. At least for the next 2 versions. It's again a special case where we
can change it even it is a incompatible change.
Comment 2 thomas.lange 2009-01-27 10:44:29 UTC
.
Comment 3 thomas.lange 2009-02-11 11:10:51 UTC
As a colleague told me just now THROUGHT is not a spelling mistake at all.
The extra T was meant to indicate 'transparent'. But nevertheless in the API it
should have been something like THROUGH_TRANSPARENT.
Comment 4 thomas.lange 2009-02-11 11:22:16 UTC
It may be that this one can not be fixed since unfotunately WrapTextMode is an
enum. 

For C++ it will be ok to add an entry like (in pseudo code):
...
		THROUGH_TRANSPARENT = THROUGHT, 
...

That would just add another name to the enum *without* actually extending the enum.
But how about that in other languages like Java, Python, etc.?

tl->jsc: do our IDL files allow foe such a change?
If not we would be required to provide a whole new enum while keeping the old
ones as well for compatibility and that is completly out of question I believe.

BTW: the same problem (THROUGHT being used in API exists for other enums as well!)
Comment 5 thomas.lange 2009-02-11 11:28:30 UTC
tl: correction: In the API THROUGHT is indeed used in WrapTextMode only. The
other occurences I found are internal C++ enums which do not bother us here.
Comment 6 jsc 2009-05-14 15:11:06 UTC
jsc -> tl: you should propose this for an incompatible API change for OO.0rg 4.0
and you should propose it on the dev@api list. The necessary code changes are
part of the fix ... -> target 4.0 that is not available yet
Comment 7 thomas.lange 2009-10-12 13:11:54 UTC
.