Fix docstring build error #189
Conversation
pyvo/io/uws/tree.py
Outdated
| """ | ||
| Parameters element of a job | ||
| """ | ||
| """Parameters element of a job""" |
There was a problem hiding this comment.
My suspicion is that Parameters are recognized as a special heading and thus being complained about. Try to rephrase, maybe even saying The parameters element of a job would be enough.
There was a problem hiding this comment.
Okay yeah, I think so too. I just tried escaping it, although maybe your way is better of just rephrasing it.
There was a problem hiding this comment.
Okay tried rephrasing it but it still seems to be trying to pick it up as a keyword. I figure there has to be some way of escaping it but I'm not sure what it is...
cbanek
force-pushed
the
fix-travis-docstring
branch
from
7d18764
to
2b8e9c5
Compare
Codecov Report
@@ Coverage Diff @@
## master #189 +/- ##
=======================================
Coverage 70.81% 70.81%
=======================================
Files 37 37
Lines 3906 3906
=======================================
Hits 2766 2766
Misses 1140 1140
Continue to review full report at Codecov.
|
cbanek
force-pushed
the
fix-travis-docstring
branch
4 times, most recently
from
706aa4a
to
dc27bd7
Compare
|
Well, looks like even getting rid of the whole docstring it is still busted. I'm guessing it's the name fo the class that's the problem. |
From Travis: Warning, treated as error: /home/travis/build/astropy/pyvo/build/lib/pyvo/io/uws/tree.py:docstring of pyvo.io.uws.tree.Parameters:22:Unexpected section title or transition. Looks like sphinx is confusing Parameters (the name of the class) for a heading of where the parameters to a function call should be. This happens even if I get rid of all the docstrings. So instead, since this is a fairly internal class, I'm going to rename the class to ParametersElement.
cbanek
force-pushed
the
fix-travis-docstring
branch
from
dc27bd7
to
1ec3a9b
Compare
|
Well, can't say I'm exactly thrilled that I'm changing the name of a class to get the docs to build, but I guess it is what it is. This is a deep class that shouldn't be exposed to everyone, and the name of the XML part (still parameters) is passed in and not inferred from the name. Open to other suggestions. |
|
Closing this one out in favor of #193 |
From Travis:
Warning, treated as error:
/home/travis/build/astropy/pyvo/build/lib/pyvo/io/uws/tree.py:docstring of pyvo.io.uws.tree.Parameters:22:Unexpected section title or transition.