Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.
  2. We have updated the language to the Editor Terms based on feedback from our employees and community. Learn more.
    Dismiss Notice

Unity Documentation Corrections

Discussion in 'Documentation' started by Kirkules_, Aug 5, 2014.

  1. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
    I'm reading the Unity user manual this week. I wanted to know if it is ok to post the errors I find in the manual here?

    I didn't report the first one I saw, I may remember and go back and find it, but this is the 2nd.

    On this page: http://docs.unity3d.com/Manual/RandomNumbers.html

    The "<" symbol was html encoded, whoops.


    if (randomPoint &lt; probs)
     
  2. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
    Here's another.

    In this file: http://docs.unity3d.com/Manual/InstantiatingPrefabs.html

    The example code following the line of text below has closing brackets in the wrong place. It appears they pasted the C# example above the javascript example's function KillSelf's closing bracket.

    The following example shows how these steps are modelled in code
     
  3. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
  4. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
    The following text in this file: http://docs.unity3d.com/Manual/class-TimeManager.html

    For example, the frame rate can drop due to an appearance of many game onscreen, or because the user launched another application in the background.


    'many game onscreen' should be 'many gameObjects onscreen' or something similar.
     
  5. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
    In this file: http://docs.unity3d.com/Manual/editor-EditorWindows.html

    The following C# example is posted twice on the page, one after another.. one of them should be removed.


    Code (CSharp):
    1. //C# Example
    2.  
    3. using UnityEngine;
    4. using UnityEditor;
    5. using System.Collections;
    6.  
    7. public class Example : EditorWindow
    8.  
    9.     {
    10.         void OnGUI () {
    11.             // The actual window code goes here
    12.            }
    13.     }
     
    shkar-noori likes this.
  6. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
    Last edited: Aug 7, 2014
  7. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
  8. Kirkules_

    Kirkules_

    Joined:
    Aug 5, 2014
    Posts:
    65
  9. FriendlyHo

    FriendlyHo

    Joined:
    Aug 18, 2014
    Posts:
    23
    When will we see new gui documentation?
     
  10. TuesdayNinja

    TuesdayNinja

    Unity Technologies

    Joined:
    Apr 23, 2013
    Posts:
    17
    @Kirkules_

    Thanks for letting us know about this stuff. I'll send it on to the docs team. However, we've now implemented a new feature that allows you to report errors directly to them - just look for the "Suggest a change" hyperlink at the top right of each page. Click that, and throw your suggestion in!
     
    Last edited: Aug 21, 2014
  11. TuesdayNinja

    TuesdayNinja

    Unity Technologies

    Joined:
    Apr 23, 2013
    Posts:
    17
    You'll have to use the docs bundled with the 4.6 open beta rather than the online docs. Just go to "Help" in the toolbar; the docs are right there. Once 4.6 is an official release, we'll put them online.