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

graphics documentation obscure #23380

Open
videlec opened this issue Jul 6, 2017 · 3 comments
Open

graphics documentation obscure #23380

videlec opened this issue Jul 6, 2017 · 3 comments

Comments

@videlec
Copy link
Contributor

videlec commented Jul 6, 2017

The one line description of text refers to arguments (x,y) that do not appear in the signature

Signature:      text(*args, **kwds)
Docstring:     
   Returns a 2D text graphics object at the point (x,y).

   Type "text.options" for a dictionary of options for 2D text.
...

Idem for point2d (that even refers to size)

Signature:      point2d(*args, **kwds)
Docstring:     
   A point of size "size" defined by point = (x,y).
...

Or for polygon2d

Signature:      polygon2d(*args, **kwds)
Docstring:     
   Returns a 2-dimensional polygon defined by "points".

The first examples of line2d are completely useless

Signature:      line2d(*args, **kwds)
Docstring:     
   Create the line through the given list of points.
...
EXAMPLES:

   A line with no points or one point:

      sage: line([])      #returns an empty plot
      Graphics object consisting of 0 graphics primitives
      sage: import numpy; line(numpy.array([]))
      Graphics object consisting of 0 graphics primitives
      sage: line([(1,1)])
      Graphics object consisting of 1 graphics primitive

CC: @mforets

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/23380

@videlec videlec added this to the sage-8.0 milestone Jul 6, 2017
@videlec

This comment has been minimized.

@videlec

This comment has been minimized.

@videlec

This comment has been minimized.

@mkoeppe mkoeppe removed this from the sage-8.0 milestone Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants