Skip to content

Fix method doc signatures for multiline required parameters #374

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

Merged
merged 2 commits into from
Mar 27, 2017
Merged

Fix method doc signatures for multiline required parameters #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
502267c
Fix method doc signatures for multiline required parameters.
tcoffee-google Mar 25, 2017
bfa9182
Regen docs
tcoffee-google Mar 25, 2017
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions describe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,15 +200,23 @@ def method_params(doc):
args = doclines[begin+1:]

parameters = []
pname = None
desc = ''
def add_param(pname, desc):
if pname is None:
return
if '(required)' not in desc:
pname = pname + '=None'
parameters.append(pname)
for line in args:
m = re.search('^\s+([a-zA-Z0-9_]+): (.*)', line)
if m is None:
desc += line
continue
add_param(pname, desc)
pname = m.group(1)
desc = m.group(2)
if '(required)' not in desc:
pname = pname + '=None'
parameters.append(pname)
add_param(pname, desc)
parameters = ', '.join(parameters)
else:
parameters = ''
Expand Down
8 changes: 4 additions & 4 deletions docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2>Instance Methods</h2>
<p class="firstline">Returns the users Resource.</p>

<p class="toc_element">
<code><a href="#create">create(accountId=None, body, x__xgafv=None)</a></code></p>
<code><a href="#create">create(accountId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new client buyer.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, clientAccountId, x__xgafv=None)</a></code></p>
Expand All @@ -97,11 +97,11 @@ <h2>Instance Methods</h2>
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(accountId=None, clientAccountId, body, x__xgafv=None)</a></code></p>
<code><a href="#update">update(accountId, clientAccountId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing client buyer.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(accountId=None, body, x__xgafv=None)</code>
<code class="details" id="create">create(accountId, body, x__xgafv=None)</code>
<pre>Creates a new client buyer.

Args:
Expand Down Expand Up @@ -342,7 +342,7 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="update">update(accountId=None, clientAccountId, body, x__xgafv=None)</code>
<code class="details" id="update">update(accountId, clientAccountId, body, x__xgafv=None)</code>
<pre>Updates an existing client buyer.

Args:
Expand Down
28 changes: 14 additions & 14 deletions docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,20 @@
<h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.html">clients</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.invitations.html">invitations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(accountId, clientAccountId=None, body, x__xgafv=None)</a></code></p>
<code><a href="#create">create(accountId, clientAccountId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and sends out an email invitation to access</p>
<p class="toc_element">
<code><a href="#get">get(accountId, clientAccountId=None, invitationId, x__xgafv=None)</a></code></p>
<code><a href="#get">get(accountId, clientAccountId, invitationId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an existing client user invitation.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the client users invitations for a client</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(accountId, clientAccountId=None, body, x__xgafv=None)</code>
<code class="details" id="create">create(accountId, clientAccountId, body, x__xgafv=None)</code>
<pre>Creates and sends out an email invitation to access
an Ad Exchange client buyer account.

Expand All @@ -105,11 +105,11 @@ <h3>Method Details</h3>
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
}

x__xgafv: string, V1 error format.
Expand All @@ -126,16 +126,16 @@ <h3>Method Details</h3>
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
}</pre>
</div>

<div class="method">
<code class="details" id="get">get(accountId, clientAccountId=None, invitationId, x__xgafv=None)</code>
<code class="details" id="get">get(accountId, clientAccountId, invitationId, x__xgafv=None)</code>
<pre>Retrieves an existing client user invitation.

Args:
Expand All @@ -157,16 +157,16 @@ <h3>Method Details</h3>
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
}</pre>
</div>

<div class="method">
<code class="details" id="list">list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the client users invitations for a client
with a given account ID.

Expand Down Expand Up @@ -209,11 +209,11 @@ <h3>Method Details</h3>
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
},
],
}</pre>
Expand Down
12 changes: 6 additions & 6 deletions docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,20 @@
<h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.html">clients</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, clientAccountId=None, userId, x__xgafv=None)</a></code></p>
<code><a href="#get">get(accountId, clientAccountId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an existing client user.</p>
<p class="toc_element">
<code><a href="#list">list(accountId=None, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the known client users for a specified</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, clientAccountId=None, userId, body, x__xgafv=None)</a></code></p>
<code><a href="#update">update(accountId, clientAccountId, userId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing client user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, clientAccountId=None, userId, x__xgafv=None)</code>
<code class="details" id="get">get(accountId, clientAccountId, userId, x__xgafv=None)</code>
<pre>Retrieves an existing client user.

Args:
Expand Down Expand Up @@ -130,7 +130,7 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(accountId=None, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the known client users for a specified
sponsor buyer account ID.

Expand Down Expand Up @@ -208,7 +208,7 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="update">update(accountId, clientAccountId=None, userId, body, x__xgafv=None)</code>
<code class="details" id="update">update(accountId, clientAccountId, userId, body, x__xgafv=None)</code>
<pre>Updates an existing client user.
Only the user status can be changed on update.

Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h2>Instance Methods</h2>
<code><a href="#add">add(accountId, creativeId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Associate an existing deal with a creative.</p>
<p class="toc_element">
<code><a href="#list">list(accountId=None, creativeId=None, pageSize=None, pageToken=None, x__xgafv=None, query=None)</a></code></p>
<code><a href="#list">list(accountId, creativeId, pageSize=None, pageToken=None, x__xgafv=None, query=None)</a></code></p>
<p class="firstline">List all creative-deal associations.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
Expand Down Expand Up @@ -126,7 +126,7 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(accountId=None, creativeId=None, pageSize=None, pageToken=None, x__xgafv=None, query=None)</code>
<code class="details" id="list">list(accountId, creativeId, pageSize=None, pageToken=None, x__xgafv=None, query=None)</code>
<pre>List all creative-deal associations.

Args:
Expand Down
Loading