Update core documentation to match recent C# changes #40501
Conversation
aaronfranke
force-pushed
the
core-docs-cs
branch
from
1f6c0a6 to
86bce1d
Compare
|
Needs a rebase on current |
aaronfranke
force-pushed
the
core-docs-cs
branch
2 times, most recently
from
a1d5759 to
63c126a
Compare
|
Sorry, needs another rebase to fix CI, emscripten this time :) |
| @@ -303,7 +305,7 @@ | |||
| <argument index="0" name="n" type="Vector2"> | |||
| </argument> | |||
| <description> | |||
| Returns the component of the vector along a plane defined by the given normal. | |||
| Returns this vector slid along a plane defined by the given normal. | |||
There was a problem hiding this comment.
I'm not sure this is clear enough as is (wasn't clear enough before either), especially to non-native speakers who may not be familiar with the past-participle of "slide" (or for anyone, the meaning of "sliding a vector along a plane").
There was a problem hiding this comment.
I'm not really familiar with this function; I don't know what it's used for. This is the best documentation I can write for it, perhaps someone else can improve it further.
| @@ -304,7 +306,7 @@ | |||
| <argument index="0" name="n" type="Vector3"> | |||
| </argument> | |||
| <description> | |||
| Returns the component of the vector along a plane defined by the given normal. | |||
| Returns this vector slid along a plane defined by the given normal. | |||
| # a is 0.5 | ||
| a = wrapf(10.5, 0.0, 10.0) | ||
| [/codeblock] | ||
| [codeblock] | ||
| # a is 9.5 | ||
| a = wrapf(-0.5, 0.0, 10.0) | ||
| [/codeblock] |
There was a problem hiding this comment.
Why remove those examples? Users are always asking for more examples.
There was a problem hiding this comment.
These examples aren't relevant for wrapf, because these are cases where it's better to use fposmod.
|
Once merged, a non-compat-breaking version of the documentation improvements would be welcome for the |
Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <[email protected]>
aaronfranke
force-pushed
the
core-docs-cs
branch
from
9198f9e to
83e324d
Compare
|
In addition to the above suggestions, I also added the Plane equation suggestions in the C# documentation. |
|
Thanks! |
Also a few minor API changes like adding AABB.abs() to match Rect2. The "recent C# changes" mentioned is #40218.