Closed kalekundert closed 4 years ago
The tests are failing with the message:
ValueError: line 855 of the docstring for inform.py has inconsistent leading whitespace: ' """'
I am not sure what is going on as line 855 does not appear to be a docstring.
Could you make the following enhancements:
Also, in the description of the cast argument you say it is a function that casts to a 'sensible type'. Could you give more detail. In this context I don't know what 'sensible' means.
Hopefully this commit addresses your comments. I'm not sure what you meant about testing the cast and range arguments, though; there are already lots of tests for both arguments.
I'm not sure why the build isn't passing for python 3.5, but I don't think it's anything related to my code. It seems like some sort of version issue with pytest.
For what it's worth, I don't think the current distinction between the API docs and the "User's Guide" makes sense. The two sections are very redundant. I think it be better to reorganize a bit:
.. autosummary::
directives to make links to the API docs.I think that would make the user's guide a more useful entry point for new users, while making the docs easier to write and maintain. That's just my opinion, though, don't feel obligated to do anything.
Also, if/when you merge this PR, can you make a new release?
These functions are for converting between with strings like "1-3,5" and the sets they represent, e.g.
{1,2,3,5}
. This is useful because it's easy for humans to read and write these strings.