search

prisonerjohn / processing-web

0 stars 0 forks source link

[CLOSED] PVector documentation for div() and mult() #138

Open prisonerjohn opened 10 years ago

prisonerjohn commented 10 years ago

Issue by shiffman Tuesday May 14, 2013 at 22:57 GMT Originally opened as https://github.com/processing/processing-web/issues/138

To avoid confusion, we've removed the following div() and mult() methods.

.div(v) .div(v1, v2) .div(v1, v2, target)

.mult(v) .mult(v1, v2) .mult(v1, v2, target)

Can we remove these from documentation @REAS / @alignedleft ?

See: https://github.com/processing/processing/issues/1544

prisonerjohn commented 10 years ago

Comment by alignedleft Tuesday May 14, 2013 at 23:20 GMT

Yes, I'll take care of it.

prisonerjohn commented 10 years ago

Comment by alignedleft Thursday May 16, 2013 at 20:35 GMT

Fixed with a331dfbf12

@shiffman, I notice that div() and multi() are still in the PVector.java source. Should they be removed or commented out? Or are we keeping them, but just not documenting them?

prisonerjohn commented 10 years ago

Comment by shiffman Thursday May 16, 2013 at 20:57 GMT

Sorry for the confusion. we did not remove div() and mult() entirely just the versions where a PVector is divided or multiplied by a PVector, i.e.

This is removed:

void div(PVector v)

but this is not removed

void div(float n)

prisonerjohn commented 10 years ago

Comment by alignedleft Thursday May 16, 2013 at 21:00 GMT

Oops, I misunderstood. I'll add the correct versions back in. Sorry!

prisonerjohn commented 10 years ago

Comment by alignedleft Wednesday May 22, 2013 at 18:01 GMT

@shiffman This is fixed, so now only one version each of mult() and div() appear.

Yet the methods that take other PVectors are still in the source (just not documented). Can you confirm that's intended?

prisonerjohn commented 10 years ago

Comment by shiffman Thursday May 23, 2013 at 19:15 GMT

You are referring to:

  static public PVector mult(PVector v, float n) {

Is this not documented? Hmmm, maybe we should document the static methods. I am having a deja vu that we had this conversation before. The static methods are for getting the result in a new PVector, i.e.

PVector a = new PVector(3,2);
a.mult(2);
// a is now (6,4)

vs.

PVector a = new PVector(3,2);
PVector b = PVector.mult(a,2);
// a is the same but b is now (6,4)
prisonerjohn commented 10 years ago

Comment by alignedleft Thursday May 23, 2013 at 21:48 GMT

@shiffman I believe this is fixed, per our discussions today. Can you take a look and confirm before I close this issue?

prisonerjohn commented 10 years ago

Comment by shiffman Friday May 24, 2013 at 01:26 GMT

I made one small edit (46edb3f04273d084fcdea8a7f8ef0fc0b0672bba) and now it's all set!