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.

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

poly documentation is rather short #814

Closed
plut opened this issue Jan 12, 2021 · 2 comments
Closed

poly documentation is rather short #814

plut opened this issue Jan 12, 2021 · 2 comments

Comments

@plut
Copy link

plut commented Jan 12, 2021

(Discovering Makie)

I am trying to draw polygonal shapes using Makie.jl. However, the current documentation for function poly is, let's say, quite short.
None of the following lines (adapted from the mesh example) work for me:

poly([0 0;0 4;4 0]) # a triangle
poly([0 0;0 4;4 0],[1 2;2 3;3 1]) # same, with edge info
poly([[0,0],[0,4],[4,0]]) # maybe a vector of points...?
poly([0 0;0 4;4 0;0 1; 1 2; 2 0],[1 2;2 3;3 1;4 6;6 5;5 4]) # holed triangle

(the error being: There was no AbstractPlotting.convert_arguments overload found for
the plot type Combined{AbstractPlotting.scatter,ArgType} where ArgType, or its conversion trait AbstractPlotting.PointBased().
The arguments were:
(Array{Array{Int64,1},1},)
)

Does the poly function really require types from GeometryBasics.jl as inputs? I'd rather not (as of right now, the documentation of that package is broken, so I can't use it. Besides, I hope the poly function uses interfaces instead of types...). Also, why does it mention scatter in the error message?

(By the way, among the various undocumented “features” of poly is the fact that a polygon is somehow supposed to be entered in retrograde orientation, which can be seen by reversing the order of the points on the example on the documentation page).

@fatteneder
Copy link
Contributor

Don't know how the poly docs look back then, but I think the current page now gives five comprehensive examples with plots: https://docs.makie.org/v0.18.3/examples/plotting_functions/poly/index.html

What do you think?

@ffreyer
Copy link
Collaborator

ffreyer commented Aug 22, 2024

Closing this as outdated/fixed

@ffreyer ffreyer closed this as completed Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants