FIX parsing of type-only return params

[timhoffm]

Fixes #72.

The sections "Parameters" and "Returns" have different semantics for single-element parameter headers. For "Parameters", the header is the name, for "Returns" the header is the type. This was not reflected in the code as both sections used the same parser.

Note: This is just a quick write-up how the code should work. I've not yet let run the tests (they may need fixing as well as mentioned in #72). But for brevity I'll let CI decide on that.

[timhoffm]

Note: CI currently fails because of pip changes (#174).

[jnothman]

if you've not had to modify any tests, how do we know this affects output?

[timhoffm]

As said above, I didn't run any tests so far myself. It's apparent that one parser for "Parameters" and "Returns" cannot get both right. I'm confident that the proposed code change itself is correct. What has to be still shown is that the calling code and tests work with that (it might be that they partly compensate for the original bug or that this effect is not tested as all). I thought I'd use the tests in CI for that, but CI is already prematurely failing for different reasons.

[timhoffm]

Rebased onto master.

Note: The tests do currently fail. Waiting for #176 before doing any further changes to fix tests.

[timhoffm]

PR updated.

Single element returns params such as:

Returns
-------
int
    The return value.

were detected as names. I.e. int was considered a name. This logical error has been fixed such that int is now a type and the name is empty.

As a consequence, int is not formatted bold anymore. This is consistent with the formatting of types in patterns like x : int and a prerequisite for type references like :class:`MyClass` to work in this position.

[mattip]

ping?

[larsoner]

@timhoffm can you rebase? Then I can take a look and hopefully merge

[larsoner]

Other than the conflict, LGTM +1 for merge

[rgommers]

I've taken the liberty of fixing the merge conflict. The only nontrivial change was deciding where the new heading Receives goes; I added it to 'Returns', 'Yields', 'Raises', 'Warns'.

[larsoner]

LGTM +1 for merge

[rgommers]

Okay in it goes. Thanks @timhoff, and sorry it took a while! And thanks @larsoner for reviewing

[timhoff]

This is funny. I am a programmer and a member of github, but you missed adding an “m" to the end of the address. It should be @timhoffm. LOL

…

On Apr 10, 2019, at 9:52 AM, Ralf Gommers ***@***.***> wrote: Okay in it goes. Thanks @timhoff <https://github.com/timhoff>, and sorry it took a while! And thanks @larsoner <https://github.com/larsoner> for reviewing — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#175 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAUFPcnOS0fLprMfPFZCxNUIUeR0rjQ-ks5vfhbXgaJpZM4TwQxl>.

[rgommers]

hmm odd, I thought I tab-completed that. Sorry for the noise @timhoff. And thanks @timhoffm !