##// END OF EJS Templates
docs: embed: add parameters to docstring...
docs: embed: add parameters to docstring The docstring of IPython.terminal.embed.embed() does not document its arguments. Add a "Parameters" section, and document each argument appropriately: - for 'header', rephrase the corresponding description from the docstring of InteractiveShellEmbed.__call__, to which this argument is passed (__call__ itself is missing from the generated API documentation since sphinx.ext.autodoc does not document special members by default). - for 'compile_flags', refer to the documentation of InteractiveShellEmbed.mainloop, to which this argument is passed. - for 'kwargs', refer to the constructor of InteractiveShellEmbed, and fold in the sentence mentioning the 'config' argument.

File last commit:

r25236:fd1a027a
r28186:97d929ec
Show More
.meeseeksdev.yml
22 lines | 380 B | text/x-yaml | YamlLexer
users:
LucianaMarques:
can:
- tag
special:
everyone:
can:
- say
- tag
- untag
- close
config:
tag:
only:
- good first issue
- async/await
- backported
- help wanted
- documentation
- notebook
- tab-completion
- windows