:param section: The section to add the docs to. :param value: The input / output values representing the parameters that are included in the example. :param comments: The dictionary containing all the comments to be applied to
(self, section, value, comments, path, shape)
| 74 | closing_section.style.end_codeblock() |
| 75 | |
| 76 | def _document(self, section, value, comments, path, shape): |
| 77 | """ |
| 78 | :param section: The section to add the docs to. |
| 79 | |
| 80 | :param value: The input / output values representing the parameters that |
| 81 | are included in the example. |
| 82 | |
| 83 | :param comments: The dictionary containing all the comments to be |
| 84 | applied to the example. |
| 85 | |
| 86 | :param path: A list describing where the documenter is in traversing the |
| 87 | parameters. This is used to find the equivalent location |
| 88 | in the comments dictionary. |
| 89 | """ |
| 90 | if isinstance(value, dict): |
| 91 | self._document_dict(section, value, comments, path, shape) |
| 92 | elif isinstance(value, list): |
| 93 | self._document_list(section, value, comments, path, shape) |
| 94 | elif isinstance(value, numbers.Number): |
| 95 | self._document_number(section, value, path) |
| 96 | elif shape and shape.type_name == 'timestamp': |
| 97 | self._document_datetime(section, value, path) |
| 98 | else: |
| 99 | self._document_str(section, value, path) |
| 100 | |
| 101 | def _document_dict( |
| 102 | self, section, value, comments, path, shape, top_level=False |
no test coverage detected