Search Unity

Documentation needs to tell viewers what alternate functions to use for deprecated functions.

Discussion in 'Documentation' started by asperatology, Jun 26, 2015.

  1. asperatology

    asperatology

    Joined:
    Mar 10, 2015
    Posts:
    981
    I will be using an example documentation page. This applies to all other documentation pages, so there's not just one.

    At the very top of this doc page, the first C# method/JavaScript function is deprecated, and it's encouraged to use the second C# method/JavaScript function. The problem here is that there's nothing to tell the viewers/readers that the first C# method/JavaScript function is deprecated. There's no indication anywhere on that doc page.

    I would like to request that there should be some deprecated method/function markers or icons to indicate what functions are planned to be deprecated, or what functions are obsolete for future Unity engines.

    Here's a mockup:

    unity_2.png

    That's all.