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

Update the docstring for vector method (2.8.0) #186

Open
jypeter opened this issue Apr 27, 2017 · 2 comments
Open

Update the docstring for vector method (2.8.0) #186

jypeter opened this issue Apr 27, 2017 · 2 comments
Assignees
Milestone

Comments

@jypeter
Copy link
Member

jypeter commented Apr 27, 2017

The docstring of the vectors is out of date

  • the scaletype and scalerange parameters are not described in the docstring and I wonder what they do, or how they interact with scale and reference
reference =  1e+20
scaletype =  constantNNormalize
scalerange =  [0.1, 1.0]
  • the values specified for type in docstring are not allowed (or maybe the docstring is ambiguous?). I have not checked the other parameters. Besides, changing the value of type does not seem to do anything (vector type does not work? (2.8.0) #185)
 |              # Same as vc.type='arrow head'
 |              vc.type=0
 |              # Same as vc.type='wind barbs'
 |              vc.type=1
 |              # Same as vc.type='solid arrow head'
 |              vc.type=2
>>> vect_gm.type = 'arrow head'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/share/unix_files/cdat/miniconda2/envs/cdatm14/lib/python2.7/site-packages/vcs/vector.py", line 629, in _settype
    value = VCS_validation_functions.checkVectorType(self, 'type', value)
  File "/home/share/unix_files/cdat/miniconda2/envs/cdatm14/lib/python2.7/site-packages/vcs/VCS_validation_functions.py", line 868, in checkVectorType
    ' can either be ("arrows", "barbs", "solidarrows") or (0, 1, 2).')
  File "/home/share/unix_files/cdat/miniconda2/envs/cdatm14/lib/python2.7/site-packages/vcs/VCS_validation_functions.py", line 59, in checkedRaise
    raise ex(err)
ValueError: The type can either be ("arrows", "barbs", "solidarrows") or (0, 1, 2).
@doutriaux1
Copy link
Contributor

this might be fixed already. Did you test nightly?

@jypeter
Copy link
Member Author

jypeter commented Apr 28, 2017

No, I have just tried it in 2.8.0

I only install stable versions :)

@doutriaux1 doutriaux1 modified the milestone: 3.0 May 5, 2017
@doutriaux1 doutriaux1 modified the milestones: 3.0, Next Release Mar 29, 2018
@doutriaux1 doutriaux1 modified the milestones: 8.1, 8.2 Mar 27, 2019
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

4 participants