Documentation feedback

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
(Comments in example snippets)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
This page serves for errata, comments and general bashing of the official docs.unity3d.com documentation.
+
This page serves for errata, unofficial bug reporting, comments and general bashing of the official docs.unity3d.com documentation.
  
 
Please remain civil and avoid swear words and personal insults to the impersonal documentation staff. They're probably doing as good a job as they can given whatever resource limitations they may have.
 
Please remain civil and avoid swear words and personal insults to the impersonal documentation staff. They're probably doing as good a job as they can given whatever resource limitations they may have.
Line 13: Line 13:
  
 
:I'm pretty sure those aren't generated, there are three separate code samples written by humans. They probably just didn't have time/forgot to copy over the comments. [[User:Ppeterson|Ppeterson]] ([[User talk:Ppeterson|talk]]) 09:30, 1 April 2013 (CEST)
 
:I'm pretty sure those aren't generated, there are three separate code samples written by humans. They probably just didn't have time/forgot to copy over the comments. [[User:Ppeterson|Ppeterson]] ([[User talk:Ppeterson|talk]]) 09:30, 1 April 2013 (CEST)
 +
 +
=== Links to "Manual" ===
 +
 +
Some links from API docs to manual are broken, e.g.
 +
* [http://docs.unity3d.com/Documentation/Manual/class-AudioSource.html] from [http://docs.unity3d.com/Documentation/ScriptReference/AudioSource.html]
 +
* [http://docs.unity3d.com/Documentation/Manual/class-AudioListener.html] from [http://docs.unity3d.com/Documentation/ScriptReference/AudioListener.html]
 +
* find more! Adventure!
  
 
== Specific articles ==
 
== Specific articles ==
Line 29: Line 36:
 
* "... so that the transform's y-axis"; Vector3.up is the global coordinate y-axis, not the Transform's y-axis.
 
* "... so that the transform's y-axis"; Vector3.up is the global coordinate y-axis, not the Transform's y-axis.
 
* "goes along the z-axis" of what exactly? Transform.forward at least indeed is the Transform's z-axis.
 
* "goes along the z-axis" of what exactly? Transform.forward at least indeed is the Transform's z-axis.
 +
 +
=== [http://docs.unity3d.com/Documentation/ScriptReference/GUI.Button.html GUI.Button] ===
 +
 +
Description:
 +
* Make a single press button. The user clicks '''them''' and something happens immediately.
 +
** immediately?

Latest revision as of 07:42, 7 June 2013

This page serves for errata, unofficial bug reporting, comments and general bashing of the official docs.unity3d.com documentation.

Please remain civil and avoid swear words and personal insults to the impersonal documentation staff. They're probably doing as good a job as they can given whatever resource limitations they may have.


Contents

[edit] General

[edit] Comments in example snippets

How come the comments fall off when you switch from UnityScript to other languages? Can't the code generator keep the comments preceding the line where they were in the UnityScript source?

Would it really be so expensive to write three sets of example snippets? They aren't overly verbose to begin with...

I'm pretty sure those aren't generated, there are three separate code samples written by humans. They probably just didn't have time/forgot to copy over the comments. Ppeterson (talk) 09:30, 1 April 2013 (CEST)

[edit] Links to "Manual"

Some links from API docs to manual are broken, e.g.

[edit] Specific articles

[edit] Quaternion.FromToRotation

The example code, when set as the sole line of a GameObject's Update, only makes it spin wildly.

Reason may be a misunderstanding apparent from the comments - or, of course, that the snippet wasn't meant to do anything relevant to begin with.

// Sets the rotation so that the transform's y-axis goes along the z-axis
transform.rotation = Quaternion.FromToRotation(Vector3.up, transform.forward);
  • "... so that the transform's y-axis"; Vector3.up is the global coordinate y-axis, not the Transform's y-axis.
  • "goes along the z-axis" of what exactly? Transform.forward at least indeed is the Transform's z-axis.

[edit] GUI.Button

Description:

  • Make a single press button. The user clicks them and something happens immediately.
    • immediately?
Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox