Re: Proposal: add strikethrough effect to removed functions and gray out deprecated functions in function lists

From: Date: Tue, 12 Nov 2013 15:21:57 +0000
Subject: Re: Proposal: add strikethrough effect to removed functions and gray out deprecated functions in function lists
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969384723@lists.php.net to get a copy of this message
On Tue, Nov 12, 2013 at 9:49 AM, Andrea Faulds <ajf@ajf.me> wrote: > Hello all, > > Currently, contents pages with lists of functions, and the sidebars on > function pages, do not show you whether a function is removed or > deprecated. In fact, if a function is removed, it is simply left there in > the list as if nothing had changed. So, I propose two small visual tweaks. > If a function has been removed, it has a strike-through effect on its name. > If a function has been deprecated, its name is in gray. If a function is > both removed and deprecated, it is both. The effect would be purely > cosmetic, and not prevent you clicking through to see the documentation. > > This would look something like this: > http://i.imgur.com/NLFu9Zg.png > (I used Firefox's inspector to change the CSS for those three functions, > and the page was zend_logo_guid, hence it is bolded. Those functions are > actually deprecated/removed.) > > Of course, this styles doesn't have to be a strike-through or a > gray-coloured link, that's just my suggestion. > > Thoughts? > > That's a bit misleading. Functions that were removed or deprecated from minor versions of PHP 5 still need to be documented and they should be mentioned in the Migration guide so that people are aware of any BC changes. Each function page also states at the top of the page what version of PHP the function is available in. It should also state when the function was deprecated from PHP. Those functions still need to be documented though.

« previous php.doc (#969384723) next »