Return docstrings from magic functions.
(self, brief=False, rest=False)
| 181 | return MagicsDisplay(self.shell.magics_manager, ignore=[]) |
| 182 | |
| 183 | def _magic_docs(self, brief=False, rest=False): |
| 184 | """Return docstrings from magic functions.""" |
| 185 | mman = self.shell.magics_manager |
| 186 | docs = mman.lsmagic_docs(brief, missing='No documentation') |
| 187 | |
| 188 | if rest: |
| 189 | format_string = '**%s%s**::\n\n%s\n\n' |
| 190 | else: |
| 191 | format_string = '%s%s:\n%s\n' |
| 192 | |
| 193 | return ''.join( |
| 194 | [format_string % (magic_escapes['line'], fname, |
| 195 | indent(dedent(fndoc))) |
| 196 | for fname, fndoc in sorted(docs['line'].items())] |
| 197 | + |
| 198 | [format_string % (magic_escapes['cell'], fname, |
| 199 | indent(dedent(fndoc))) |
| 200 | for fname, fndoc in sorted(docs['cell'].items())] |
| 201 | ) |
| 202 | |
| 203 | @line_magic |
| 204 | def magic(self, parameter_s=''): |
no test coverage detected