IDE - Extend the warning message for deprecated functions

Got an idea for enhancing PureBasic? New command(s) you'd like to see?
c4s
Addict
Addict
Posts: 1981
Joined: Thu Nov 01, 2007 5:37 pm
Location: Germany

IDE - Extend the warning message for deprecated functions

Post by c4s »

Often newbies or users who used an older version of PB etc. come to the forum and ask about the "deprecated function CreateGadgetList()" and similar ones. I just picked out the latest thread as an example: http://www.purebasic.fr/english/viewtop ... 13&t=47147

So my ideas is to extend the warning message with more information about what the user should do to fix the issue. It could look like this:
Warning! Deprecated function used [Line 1234]: CreateGadgetList()
Solution: Remove the function

Warning! Deprecated function used [Line 4321]: CountList()
Solution: Replace it by ListSize()
I think this idea is better than e.g. still listing the old functions in the help file which can lead to confusion. Although you could create an extra "Deprecated Functions" topic about it which simply has a list with the same information as above ("CreateGadgetList() -> Remove" etc.). It would help enormously for quick and easy lookups instead of always having to look at the changelog.
If any of you native English speakers have any suggestions for the above text, please let me know (via PM). Thanks!
freak
PureBasic Team
PureBasic Team
Posts: 5940
Joined: Fri Apr 25, 2003 5:21 pm
Location: Germany

Re: IDE - Extend the warning message for deprecated function

Post by freak »

The 4.60 manual has help pages for deprecated functions. They explain how to replace them.
quidquid Latine dictum sit altum videtur
c4s
Addict
Addict
Posts: 1981
Joined: Thu Nov 01, 2007 5:37 pm
Location: Germany

Re: IDE - Extend the warning message for deprecated function

Post by c4s »

Ok, that's a good approach. However, I wouldn't say it's good to place them in the normal content list (on the far left) because they simply don't belong there anymore.
Of course it's your decision but I think listing them in a separate "Deprecated functions" topic would be the best idea - besides that really short note at the warning itself...
If any of you native English speakers have any suggestions for the above text, please let me know (via PM). Thanks!
moogle
Enthusiast
Enthusiast
Posts: 372
Joined: Tue Feb 14, 2006 9:27 pm
Location: London, UK

Re: IDE - Extend the warning message for deprecated function

Post by moogle »

freak wrote:The 4.60 manual has help pages for deprecated functions. They explain how to replace them.
Great, this will make old code converting quick and easy :)
Image
Post Reply