:param str user: koji username
:param str cg: content generator name
:param bool create: If true, Koji will create an entirely different content
                    generator in the database. If false (default), Koji
                    will add the user to an existing content generator.

While we use Sphinx for our docs, we don't at the moment use autodoc to generate api docs. We probably should (I'm not sure how much work that would be at this point), but it seems a little strange to have just one docstring with this format.

The documented types are stricter than reality. Both user and cg accept id or name. Frankly id is the safer option. Does Sphinx have syntax for this? Should those :param lines be followed up with multiple :type lines?

Thanks for clarifying that the user and cg params can be ints or strings.

I looked it up in Sphinx, and you can specify it like :type user: int or str

I've amended this pull-request to do that.

@mikem I'm thinking if we could have an API docstring template in contribution guide, then we could have them to be standardized

a little clarification
https://github.com/mikem23/koji-playground/commits/pagure/pr/1143

:thumbsup:

:thumbsup:

Thanks, I've cherry-picked that change to this PR and re-pushed.

Commit 48d2f31 fixes this pull-request