Tweaks to comments to fix generation problems with RTD

[swcurran]

Signed-off-by: Stephen Curran swcurran@gmail.com

Minor tweaks to the comments used to generate the RTD documents, but ones that prevented the display of the code. Please push these fixes through as soon as possible so that we have good docs online - currently they are blank. I didn't realize just how fragile these where - a small mistake prevents large chunks/all of the documentation from being produced.

Code related problems:

• bad indent of a list (no need to indent a bullet list)
• a ":" missing after "return"
• Missing blank line between "::" indicator and JSON
• Missing blank line between end of JSON and the """ indicator

Thanks

[swcurran]

BTW - can pylint pick these up? Or do we need to look at you being able to run the rtd generator locally?

I definitely need to look at the warnings produced from the RTD runs on the site.

[sklump]

pylint cannot pick these up.

Actually pylint is a lousy tool for a lot of newer python syntax even, but there is nothing better. We're muddling through.

[sklump]

Will incorporate the spirit of these changes in next revision, and track through file name migration as I finish the refactoring for the new encoder and deep predicate support.

[swcurran]

Spirit sounds good - as long as the syntax is right :-). Do you have a way to run rtd to verify that the format is correct? I set up a script that calls sphinx using docker if that would help. Do let me know when you have put these in so I can get them in my copy.

[sklump]

1.6.38 includes.

[sklump]

Also, I can run sphinx now.