Skip to content

correct **kwargs documentation in docstrings - #559

Merged
lahirumaramba merged 2 commits into
firebase:masterfrom
skarzi:fix/docstring/kwargs
Nov 30, 2021
Merged

lahirumaramba merged 2 commits into
firebase:masterfrom
skarzi:fix/docstring/kwargs

Conversation

@skarzi

@skarzi skarzi commented Jul 6, 2021

Copy link
Copy Markdown
Contributor

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

google-cla Bot commented Jul 6, 2021

Copy link
Copy Markdown

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

skarzi commented Jul 6, 2021

Copy link
Copy Markdown
Contributor Author

@googlebot I signed it!

@lahirumaramba lahirumaramba self-assigned this Jul 6, 2021
@lahirumaramba

Copy link
Copy Markdown
Member

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

@lahirumaramba
lahirumaramba requested a review from egilmorez July 6, 2021 20:10
@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.

2 participants