Re: [sage-devel] self in the INPUT section of the docstring

2015-02-08 Thread John Cremona
As long as the restriction is documented somewhere in the docstring, and there is a reasonable error raised when the conditions are not met, it does not seem to me to be essential to include self in the INPUT block. For a common example I looked at the factor() method for ZZ, which certainly does

[sage-devel] self in the INPUT section of the docstring

2015-02-08 Thread martin . vgagern
Hello. This post is motivated by #17567 . There I implemented a method which is only defined for vectors of length 3 and 7. I felt like documenting the fact “self has to be length 3 or 7” in the INPUT section of the docstring would be a good ide