Decorator for docstrings referring to objects imported from nbformat.current

IPython/nbconvert/exporters/exporter.py

@@ -32,9 +32,6 b' from IPython.utils.traitlets import MetaHasTraits, Unicode, List'
 from IPython.utils.importstring import import_item
 from IPython.utils import text, py3compat
 
-from IPython.nbconvert import preprocessors as nbpreprocessors
-
-
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
@@ -96,14 +93,14 b' class Exporter(LoggingConfigurable):'
     def default_config(self):
         return Config()
 
-
+    @nbformat.docstring_nbformat_mod
     def from_notebook_node(self, nb, resources=None, **kw):
         """
         Convert a notebook from a notebook node instance.
 
         Parameters
         ----------
-        nb : :class:`~IPython.nbformat.v3.nbbase.NotebookNode`
+        nb : :class:`~{nbformat_mod}.nbbase.NotebookNode`
           Notebook node
         resources : dict
           Additional resources that can be accessed read/write by

IPython/nbconvert/exporters/templateexporter.py

@@ -27,6 +27,7 b' from IPython.utils.traitlets import MetaHasTraits, Unicode, List, Dict, Any'
 from IPython.utils.importstring import import_item
 from IPython.utils import py3compat, text
 
+from IPython.nbformat.current import docstring_nbformat_mod
 from IPython.nbconvert import filters
 from .exporter import Exporter
 
@@ -186,14 +187,15 b' class TemplateExporter(Exporter):'
             else:
                 self.log.info("Loaded template %s", try_name)
                 break
-    
+
+    @docstring_nbformat_mod
     def from_notebook_node(self, nb, resources=None, **kw):
         """
         Convert a notebook from a notebook node instance.
     
         Parameters
         ----------
-        nb : :class:`~IPython.nbformat.v3.nbbase.NotebookNode`
+        nb : :class:`~{nbformat_mod}.nbbase.NotebookNode`
           Notebook node
         resources : dict
           Additional resources that can be accessed read/write by

IPython/nbformat/current.py

@@ -30,6 +30,7 b' from IPython.nbformat.v3 import ('
     parse_filename, new_metadata, new_author, new_heading_cell, nbformat,
     nbformat_minor, to_notebook_json
 )
+from IPython.nbformat import v3 as _v_latest
 
 from .reader import reads as reader_reads
 from .reader import versions
@@ -41,6 +42,16 b' from .convert import convert'
 
 current_nbformat = nbformat
 current_nbformat_minor = nbformat_minor
+current_nbformat_module = _v_latest.__name__
+
+def docstring_nbformat_mod(func):
+    """Decorator for docstrings referring to classes/functions accessed through
+    nbformat.current.
+
+    Put {nbformat_mod} in the docstring in place of 'IPython.nbformat.v3'.
+    """
+    func.__doc__ = func.__doc__.format(nbformat_mod=current_nbformat_module)
+    return func
 
 
 class NBFormatError(ValueError):