Adding docs for docstrings and typehints - #19267
Conversation
Sean Kane (seankane-msft)
changed the title
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment: |
| will also need to be included when searching for content to be preprocessed. Not supported if | ||
| training with labels. | ||
| :keyword str model_name: An optional, user-defined name to associate with your model. | ||
| :keyword str continuation_token: A continuation token to restart a poller from a saved state. |
There was a problem hiding this comment.
We should have an example with inline type and clarify that for keyword you then need to use paramtype, while a regular param should be type
There was a problem hiding this comment.
You say that later, but still this overview should show it
There was a problem hiding this comment.
Half use inline type, half use paramtype.
|
|
||
| ### Model and Client Docstrings | ||
|
|
||
| For documenting the properties of a model or client, include a docstring right after the `__init__` method or immediately after the class declaration |
There was a problem hiding this comment.
Models that are used in requests often need to have more than just the ivars documented. Wondering if we should include an example for that as well.
There was a problem hiding this comment.
Could you provide a hint for me on that and I can include it?
There was a problem hiding this comment.
Sure, the input for document translation here: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_models.py#L150
Co-authored-by: Krista Pratico <krpratic@microsoft.com>
Laia Patiño (laiapat)
left a comment
Laia Patiño (laiapat)
left a comment
There was a problem hiding this comment.
As usual, just a nitpicking comment from me. Looks good!
Co-authored-by: McCoy Patiño <39780829+mccoyp@users.noreply.github.com>
|
/check-enforcer override |
4 participants
No description provided.