Skip to content

fix model docstring to use keyword instead of param#1026

Merged
iscai-msft merged 2 commits intoautorestv3from
model_param_to_keyword
Sep 8, 2021
Merged

fix model docstring to use keyword instead of param#1026
iscai-msft merged 2 commits intoautorestv3from
model_param_to_keyword

Conversation

@iscai-msft
Copy link
Contributor

No description provided.

@tjprescott tjprescott changed the title fix model docstring to have param instead of keyword fix model docstring to use keyword instead of param Sep 8, 2021
@tjprescott
Copy link
Member

Can we verify what impact, if any, this would have on autodoc?

@tjprescott
Copy link
Member

This PR addresses:
Azure/azure-sdk-tools#1964

Copy link
Member

@tjprescott tjprescott left a comment

Choose a reason for hiding this comment

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

This looks great to me, but we should assess any impact on generated docs. Thanks @iscai-msft

Copy link
Member

@tjprescott tjprescott left a comment

Choose a reason for hiding this comment

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

I verified that this change didn't produce any difference in the display of generated docs, so I am happy with this change. Thank you @iscai-msft!

Copy link
Member

@johanste johanste left a comment

Choose a reason for hiding this comment

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

I'll admit I didn't go through all the acceptance tests in detail.

@iscai-msft
Copy link
Contributor Author

sounds good @johanste. I'll merge this one since it's approved, will work on adding ivars and seeing what happens if we move keyword docs to __init__

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.

3 participants