From d9ef1c7f4eb36e2632b4b9ab6233e5425bf4f087 2013-07-26 22:46:52 From: Jonathan Frederic Date: 2013-07-26 22:46:52 Subject: [PATCH] Added warnings --- diff --git a/IPython/nbconvert/exporters/export.py b/IPython/nbconvert/exporters/export.py index e96fb4f..4413586 100755 --- a/IPython/nbconvert/exporters/export.py +++ b/IPython/nbconvert/exporters/export.py @@ -51,7 +51,10 @@ def DocDecorator(f): exporter_instance : Exporter Instance of the Exporter class used to export the document. Useful to caller because it provides a 'file_extension' property which - specifies what extension the output should be saved as.""" + specifies what extension the output should be saved as. + + WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT + """ @wraps(f) def decorator(*args, **kwargs): @@ -196,7 +199,10 @@ def export_by_name(format_name, nb, **kw): def get_export_names(): - "Return a list of the currently supported export targets" + """Return a list of the currently supported export targets + + WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT""" + # grab everything after 'export_' l = [x[len('export_'):] for x in __all__ if x.startswith('export_')] diff --git a/IPython/nbconvert/nbconvertapp.py b/IPython/nbconvert/nbconvertapp.py index 739a6b8..6ac273f 100755 --- a/IPython/nbconvert/nbconvertapp.py +++ b/IPython/nbconvert/nbconvertapp.py @@ -89,7 +89,9 @@ class NbConvertApp(BaseIPythonApplication): description = Unicode( u"""This application is used to convert notebook files (*.ipynb) - to various other formats.""") + to various other formats. + + WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.""") examples = Unicode(u""" The simplest way to use nbconvert is