You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ Management libraries can be identified by namespaces that start with `azure-mgmt
53
53
## Need help?
54
54
55
55
* For detailed documentation visit our [Azure SDK for Python documentation](https://aka.ms/python-docs)
56
-
* File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-python/issues)
56
+
* File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-python/issues)
57
57
* Check [previous questions](https://stackoverflow.com/questions/tagged/azure+python) or ask new ones on StackOverflow using `azure` and `python` tags.
Models are trained using documents that are of the following content type - 'application/pdf',
27
30
'image/jpeg', 'image/png', 'image/tiff', or 'image/bmp'. Other types of content in the container is ignored.
28
31
@@ -63,7 +66,7 @@ A method docstring is annotated by the Python long-string `"""<docstring>"""` ri
63
66
...
64
67
```
65
68
66
-
The first portion of this docstring is a general description of what the method does. Following the general description of the method is a **required new line** and then documentation for each of the parameters, optional keyword arguments, returned objects, and potentially raised errors.
69
+
The first portion of this docstring is a general description of what the method does. It contains a clickable link to MS documentation (note the special format and double-underscore necessary to make this work). Following the general description of the method is a **required new line** and then documentation for each of the parameters, optional keyword arguments, returned objects, and potentially raised errors.
67
70
68
71
Positional parameters can be documented in one-line or two-lines. Both options can be used in a single docstring for documenting different parameters without issue.
69
72
1. This option works best for parameters that are one of the basic types (`str`, `int`, `bool`, `bytes`, `float`, etc.)
0 commit comments