Skip to content
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.

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

correct **kwargs documentation in docstrings #559

Merged
merged 2 commits into from
Nov 30, 2021
Merged

correct **kwargs documentation in docstrings #559

merged 2 commits into from
Nov 30, 2021

Conversation

skarzi
Copy link
Contributor

@skarzi skarzi commented Jul 6, 2021

Hi 👋

first of all thanks for maintaining and developing this great SDK!

This PR fixes kwargs documentation in Args section of docstrings.
According to Google Python Style Guide *args and **kwargs should be documented in Args section using following format:

If a function accepts *foo (variable length argument lists) and/or **bar (arbitrary keyword arguments), they should be listed as *foo and **bar.

@google-cla
Copy link

google-cla bot commented Jul 6, 2021

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@skarzi
Copy link
Contributor Author

skarzi commented Jul 6, 2021

@googlebot I signed it!

@lahirumaramba lahirumaramba self-assigned this Jul 6, 2021
@lahirumaramba
Copy link
Member

Thank you @skarzi ! LGTM
Adding @egilmorez as this might update reference docs.

@lahirumaramba lahirumaramba merged commit 02596dc into firebase:master Nov 30, 2021
@skarzi skarzi deleted the fix/docstring/kwargs branch December 1, 2021 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants