Search Unity

  1. Unity 6 Preview is now available. To find out what's new, have a look at our Unity 6 Preview blog post.
    Dismiss Notice
  2. Unity is excited to announce that we will be collaborating with TheXPlace for a summer game jam from June 13 - June 19. Learn more.
    Dismiss Notice

Suggestion: version number and appendix for deprecated features

Discussion in 'Documentation' started by movra, Dec 2, 2014.

  1. movra

    movra

    Joined:
    Feb 16, 2013
    Posts:
    566
    Would be nice if the documentation showed a list of deprecated features. That would be useful for asset developers targeting multiple versions of Unity. They would be able to use preprocessor directives to switch between the obsolete and replacement features.

    For example, the PHP manual has both an appendix that lists all deprecated features for each version of PHP: http://php.net/manual/en/migration53.deprecated.php

    Additionally, the documentation page for a deprecated feature displays a warning including the version number: http://php.net/manual/en/function.ereg.php

    In the Unity Scripting API docs the flagging of deprecated features is not consistent, for example:
    - Flagged as deprecated: http://docs.unity3d.com/Manual/unity-remote.html
    - The signature WWW(url, postData, headers) has been removed but the description is still there at the bottom of the page: http://docs.unity3d.com/ScriptReference/WWW-ctor.html
     
    Dantus likes this.
  2. Dantus

    Dantus

    Joined:
    Oct 21, 2009
    Posts:
    5,667
    That sounds like a really useful feature!
     
  3. andeeeee

    andeeeee

    Joined:
    Jul 19, 2005
    Posts:
    8,768
    @movra: that does sound very useful. I'm not sure how easy it would be now to find all the feature deprecations from previous versions but we could certainly look at implementing this from the next version onward.

    The issue with the WWW constructor page is due to a bug in the script that generates the API reference pages. The bug appears to have been fixed now but the fix won't be published until the next release.
     
    movra likes this.
  4. movra

    movra

    Joined:
    Feb 16, 2013
    Posts:
    566
  5. movra

    movra

    Joined:
    Feb 16, 2013
    Posts:
    566