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

Finding deprecated documentation

Discussion in 'Documentation' started by jvo3dc, Mar 11, 2015.

  1. jvo3dc

    jvo3dc

    Joined:
    Oct 11, 2013
    Posts:
    1,520
    It is currently quite difficult to find deprecated documentation. We can't always work with the latest version of Unity, because of the large changes they impose on live projects.

    I was just building some asset bundles for iOs. The build target needed for this in a Unity version before 5.0.0 is no longer listed in the documentation. The documentation says the target is BuildTarget.iOs:
    http://docs.unity3d.com/ScriptReference/BuildTarget.iOS.html

    In a version before 5.0.0, it actually is BuildTarget.iPhone:
    http://docs.unity3d.com/ScriptReference/BuildTarget-iPhone.html

    It's fairly difficult to find that out, if it's not listed as deprecated item in:
    http://docs.unity3d.com/ScriptReference/BuildTarget.html

    I understand that maintaining separate documentations for different versions of Unity, might be a bit much, but the Java documentation for example still lists deprecated methods:
    http://docs.oracle.com/javase/7/docs/api/java/lang/String.html
     
  2. Rasmus Selsmark

    Rasmus Selsmark

    Joined:
    Mar 13, 2013
    Posts:
    120
    Documentation for older versions of Unity is available on e.g. http://docs.unity3d.com/462/Documentation/ScriptReference/BuildTarget.html in this case or you can use the offline version of the documentation installed with Unity on your machine.

    Alternatively all deprecated methods are listed on http://docs.unity3d.com/ScriptReference/40_history.html, where you also can find BuildTarget.iPhone.

    It's an ongoing discussion in the documentation team whether we should show deprecated methods in the class listings, which has both pros and cons. We of course want developers to use the latest supported non-deprecated methods, but on the other hand it should also be easy to find documentation when using older versions of Unity. So thanks for input.

    /Rasmus
     
  3. jvo3dc

    jvo3dc

    Joined:
    Oct 11, 2013
    Posts:
    1,520
    I didn't know the older documentation versions were also available. I guess that comes from my habit of using google to jump to a specific page in the documentation. I understand it is not an easy discussion, but in this specific case I can imagine you add a reference to the iPhone target from the iOs target. Since it's just an enumeration here, the BuildTarget.iOs page is fairly empty. Plenty of room to say:

    BuildTarget.iOs replaces BuildTarget.iPhone since version 5.0.0.

    That way it's easy to find in the current help version, but it doesn't clutter the main enumeration page.
     
  4. jvo3dc

    jvo3dc

    Joined:
    Oct 11, 2013
    Posts:
    1,520
    I actually just ran into the same problem again, but in a worse form. The BuildTarget MetroPlayer has been renamed to WSAPlayer. There is again no mention of the old MetroPlayer name in the WSAPlayer documentation page. To make things worse, the old documentation also doesn't list the MetroPlayer option. That combination makes it very hard to figure out that for older versions the correct BuildTarget is MetroPlayer. I would again like to suggest adding old versions of enumeration elements in the current version of the documentation.

    BuildTarget.WSAPlayer replaces BuildTarget.MetroPlayer since version 5.0.0.
     
  5. hippocoder

    hippocoder

    Digital Ape

    Joined:
    Apr 11, 2010
    Posts:
    29,723
    Docs are a bit crap at the moment. Nuff said, Reported many issues ie completely wrong enums in property description weeks ago and said issues still exist. Got tired of trying to help. Gave up.

    If this is an annoying comment then fix the broken docs, there's no two ways about it or any argument, quite shocking such things still exist tbh.