Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 12, 2021
Merged

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

merged 1 commit into from
May 12, 2021

Conversation

HacKanCuBa
Copy link
Contributor

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

Closes #88.

@HacKanCuBa
Copy link
Contributor Author

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

@HacKanCuBa HacKanCuBa force-pushed the feature/googlestyle-support-keyword-args branch from 02f9b98 to fedfc7f Compare May 8, 2021 17:31
@HacKanCuBa
Copy link
Contributor Author

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
Copy link
Member

pawamoy commented May 8, 2021

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 🙂

pawamoy
pawamoy requested changes May 8, 2021
View reviewed changes
Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's good! We just need to differentiate an "Arguments" section from a "Keyword Arguments" one 🙂

@pawamoy
Copy link
Member

pawamoy commented May 8, 2021

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

@HacKanCuBa HacKanCuBa force-pushed the feature/googlestyle-support-keyword-args branch from fedfc7f to 8424c4a Compare May 8, 2021 19:56
@HacKanCuBa
Copy link
Contributor Author

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

@HacKanCuBa
feat: Support "Keyword Args" sections for G-style
f51d07f 
Add support for "Keyword Args" and "Keyword Arguments" sections for
Google-style docstrings.

Closes mkdocstrings#88.
@HacKanCuBa HacKanCuBa force-pushed the feature/googlestyle-support-keyword-args branch from 8424c4a to f51d07f Compare May 10, 2021 01:47
@pawamoy pawamoy merged commit 0133369 into mkdocstrings:master May 12, 2021
@pawamoy
Copy link
Member

pawamoy commented May 12, 2021

Thanks again!

@pawamoy pawamoy mentioned this pull request Aug 20, 2021
Closed
@HacKanCuBa HacKanCuBa deleted the feature/googlestyle-support-keyword-args branch December 30, 2021 05:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pawamoy pawamoy pawamoy requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support "Keyword Arguments" sections in Google-style docstrings
2 participants
@HacKanCuBa @pawamoy