search

mkdocstrings / pytkdocs

Load Python objects documentation.
https://mkdocstrings.github.io/pytkdocs
ISC License
50 stars 32 forks source link

feat: Support "Keyword Args" sections for G-style #105

Closed HacKanCuBa closed 3 years ago

HacKanCuBa commented 3 years ago

Add support for "Keyword Args" and "Keyword Arguments" sections for Google-style docstrings.

Closes #88.

HacKanCuBa commented 3 years ago

Let me know if the changes and tests make sense, it seemed way too simple so I may be totally wrong.

HacKanCuBa commented 3 years ago

On a side note, running make check produces:

✗ Checking code quality (1)
✓ Type-checking
✓ Building documentation
✓ Checking dependencies

So I tried running flakehell lint src/pytkdocs but got an exception: AttributeError: 'Namespace' object has no attribute 'extended_default_ignore' so I'm not sure what's going on there.

pawamoy commented 3 years ago

Let me know if the changes and tests make sense, it seemed way too simple so I may be totally wrong.

All fine here, it was supposed to be easy :slightly_smiling_face:

pawamoy commented 3 years ago

Also, don't worry about the quality check, it is supposed to fail (we allow failures).

HacKanCuBa commented 3 years ago

Also, don't worry about the quality check, it is supposed to fail (we allow failures).

Nice, thanks. In any case, if it's something I can fix related to this PR, I'm happy to fix it! I couldn't find an output that tells me why that check fails

pawamoy commented 3 years ago

Thanks again!