update polygon doc

[MatthiasJ1]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b18af27) 95.84% compared to head (fe86f5c) 95.84%.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #395   +/-   ##
=======================================
  Coverage   95.84%   95.84%           
=======================================
  Files          24       24           
  Lines        7275     7275           
=======================================
  Hits         6973     6973           
  Misses        302      302           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gumyr]

There is no restriction to the order of the points, here is a clockwise example:

p = Polygon((0, 0), (0, 1), (1, 1), (1, 0), (0, 0), align=None)

Is the concern that the object is up-side-down?

[MatthiasJ1]

Yes. I clarified the docs.

[gumyr]

I don't understand why you're requesting this change. Both CW and CCW orders generate polygons and the code does not attempt to enforce any order. Is there something specific that is causing a problem here?

[MatthiasJ1]

Yes, that is why I specified it is the winding order which only determines the normal, not the shape.
The code does enforce an order when it comes to the polygon's normal which is what I am documenting.

[gumyr]

How about this instead?

    Add polygon(s) defined by given sequence of points to sketch. 

    Note that the order of the points define the normal of the Face that is created in Algebra mode, 
    where counter clockwise order creates Faces with their normal being up while a clockwise order 
    will have a normal that is down.  In Builder mode, all Faces are up.

with no change to the description of pts.

[MatthiasJ1]

Sounds good to me. I had to figure out the winding order by testing when lofting in algebra mode so this would address that.

[gumyr]

Fixed with commit f622815