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

Document Makie.spaces() values #3796

Open
jariji opened this issue Apr 18, 2024 · 3 comments
Open

Document Makie.spaces() values #3796

jariji opened this issue Apr 18, 2024 · 3 comments
Labels
documentation enhancement Feature requests and enhancements

Comments

@jariji
Copy link

jariji commented Apr 18, 2024

Feature description

?scatter says

 •  space::Symbol = :data sets the transformation space for box encompassing the
   volume plot. See Makie.spaces() for possible inputs.

so

julia> Makie.spaces()
(:data, :pixel, :relative, :clip)

but that function isn't documented

help?> Makie.spaces()
  No documentation found.

  Makie.spaces is a Function.

so I don't know what those things mean.

@jariji jariji added the enhancement Feature requests and enhancements label Apr 18, 2024
@asinghvi17
Copy link
Member

asinghvi17 commented Apr 18, 2024

If you want to PR this that would be great, they're pretty barebones explanations but better than nothing.

"""
		spaces()

Returns a tuple of defined and allowed coordinate spaces in Makie as symbols.

- `:data`: The space of input data, before applying `plot.transform`.  This is the space of the data you put in.
- `:pixel`: Direct pixel space on the screen, compensated for `px_per_unit` settings.  See `scene.viewport[]` for the pixel space boundingbox.
- `:relative`: Relative space goes from 0 to 1, bottom to top and left to right.  This is relative to the Scene or Axis a plot is located in.
- `:clip`: Similar to relative, but from -1 to 1 instead.  This is OpenGL clip space.
"""

@matthewelmer
Copy link

We should prolly remove See Makie.spaces() for possible inputs. from the documentation entirely until there's actually something to look for.

@asinghvi17
Copy link
Member

That would be the same amount of effort as PR'ing the explanation, though?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Feature requests and enhancements
Projects
None yet
Development

No branches or pull requests

4 participants