Skip to content

Commit e7c1352

Browse files
Update docstring.md (#33817)
1 parent f4495b7 commit e7c1352

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/dev/docstring.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ A method docstring is annotated by the Python long-string `"""<docstring>"""` ri
2222
2323
The request must include a `training_files_url` parameter that is an
2424
externally accessible Azure storage blob container URI (preferably a Shared Access Signature URI). Note that
25-
a container URI (without SAS) is accepted only when the container is public.
25+
a container URI (without SAS) is accepted only when the container is public.
26+
See `SAS container details
27+
<https://docs.microsoft.com/azure/cognitive-services/form-recognizer/build-training-data-set>`__
28+
for more details.
2629
Models are trained using documents that are of the following content type - 'application/pdf',
2730
'image/jpeg', 'image/png', 'image/tiff', or 'image/bmp'. Other types of content in the container is ignored.
2831
@@ -63,7 +66,7 @@ A method docstring is annotated by the Python long-string `"""<docstring>"""` ri
6366
...
6467
```
6568

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.
6770

6871
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.
6972
1. This option works best for parameters that are one of the basic types (`str`, `int`, `bool`, `bytes`, `float`, etc.)

0 commit comments

Comments
 (0)