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

Show ; attributes... in plot function docstrings #3795

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

Show ; attributes... in plot function docstrings #3795

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

Comments

@jariji
Copy link

jariji commented Apr 18, 2024

Feature description

We have

help?> scatter

  scatter(positions)
  scatter(x, y)
  scatter(x, y, z)


  Plots a marker for each element in (x, y, z), (x, y), or positions.

  Attributes
  ==========
...

But the signatures don't show that they accept kwargs, so I forget what I'm supposed to do with them. Suggestion: show ; attributes... in the signature.

For plot types, please add an image of how it should look like

  scatter(positions; attributes...)
  scatter(x, y; attributes...)
  scatter(x, y, z; attributes...)


Plots a marker for each element in `(x, y, z)`, `(x, y)`, or `positions`. 
`attributes` can be any of the attributes below.


  Attributes
  ==========
@jariji jariji added the enhancement Feature requests and enhancements label Apr 18, 2024
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

2 participants