Fix inspect.Parameter docstring on the kind attribute

[johnslavik]

I've checked the docs and they're correct; only the docstring was wrong.
I think we can use this pseudocode type annotation here? Open for a better idea.

[picnixz]

Is it just a C/C from the online docs?

[johnslavik]

Is it just a C/C from the online docs?

No, not at all

[picnixz]

Then I am a bit confused about the change. When I asked C/C from the online docs, I wanted to know whether the online docs indicated the description field and that 'kind' was an enumeration.

[johnslavik]

The online documentation does not specifiy whether kind is a string or int or enum, if that's what your asking (see https://docs.python.org/3/library/inspect.html#inspect.Parameter.kind). However, https://docs.python.org/3/library/inspect.html#inspect.Parameter.kind.description does imply that Parameter.kind is an enum.

Then I am a bit confused about the change.

What makes it confusing? What can I do?

[picnixz]

I am confused by "the docstring was wrong". AFAICT, it is not wrong. If you indicate that kind is an enum in te docstring it should be reflected in the online docs as well.

[johnslavik]

@picnixz, kind : str is wrong. It is never a string.

[picnixz]

Ah! I missed this change! my bad!

[picnixz]

Ah! I missed this change! my bad!

[johnslavik]

If you indicate that kind is an enum in te docstring it should be reflected in the online docs as well.

It is not explicitly reflected. Online docs don't annotate types as this docstring does.
From the .description online documentation I linked to, one can imply that inspect.Parameter.kind is an enum.

[johnslavik]

What can I do to address the concerns about the PR?

[picnixz]

Ok I actually missed the fact that it was documented as a string...

As a follow-up, I would suggest that:

• You explicitly mention that it is an enumeration in the docs.
• You explicitly say that it has a description property.

We could document the enumeration as well as a class right? (or is it an implementation detail?)