Skip to content

change: allow parameter name and type to not be separated in docstring #375

@k4lizen

Description

@k4lizen

Is your change request related to a problem? Please describe.

pwndbg was migrating from sphinx to mkdocstrings at some point and as a result there are a lot of warnings like this:

WARNING -  griffe: pwndbg/chain.py:44: No type or annotation for parameter 'limit(int)'
WARNING -  griffe: pwndbg/chain.py:44: Parameter 'limit(int)' does not appear in the function signature

because the argument and type are not separated by space. It seems generally sphinx allows this:
https://docs.pwntools.com/en/dev/elf/elf.html#pwnlib.elf.elf.ELF.read
https://github.com/Gallopsled/pwntools/blob/76078a3967/pwnlib/elf/elf.py#L1457-L1571
and the google style guide isn't too specific about it https://google.github.io/styleguide/pyguide.html#381-docstrings. This example page by sphinx seems to use https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html spaces, except in readwrite_property

Describe the solution you'd like

Allow that syntax.

Additional context

To be honest it's not too hard to fix these, and we don't really need to have the types specified in the docstring anyways (according to the style guide) because we have annotations, but if some other project migrates from sphinx they may cry because of this as this syntax seems relatively common. So I think it's a good idea to provide parity here.

Metadata

Metadata

Assignees

Labels

featureNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions