Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Polygon method documentation is incorrect #395

Open
Autoquark opened this issue Feb 8, 2025 · 1 comment · May be fixed by #396
Open

Polygon method documentation is incorrect #395

Autoquark opened this issue Feb 8, 2025 · 1 comment · May be fixed by #396
Labels
bug

Comments

@Autoquark
Copy link

Describe the bug
The polygon method documentation implies that the 'radius' parameter is the inner radius of the shape, but it is actually the outer radius. It also refers to the shape as a 'star', presumably a copy paste error from the star method.

Sorry if this isn't the right way to report a documentation bug, the existing template didn't quite fit.
@Autoquark Autoquark added the bug label Feb 8, 2025
@andymeneely
Copy link
Owner

Good catch! The file is here: https://github.com/andymeneely/squib/blob/dev/docs/dsl/polygon.rst

Would you mind doing a pull request to fix?

Autoquark added a commit to Autoquark/squib that referenced this issue Feb 21, 2025
@Autoquark
Update polygon.rst
16c2cbf 
Fixes andymeneely#395
@Autoquark Autoquark linked a pull request Feb 22, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update polygon.rst Autoquark/squib
2 participants
@andymeneely @Autoquark