def test_additional_params(self):
doc = """Jiggers the bar
Jolly important.
:params foo: Self explanatory.
:returns: The jiggered bar.
The additional parameters are passed directly into
:meth:`.get_content`. Note: the `url` parameter cannot be
altered.
"""
expected_doc = """Jiggers the bar
Jolly important.
{0}
:params foo: Self explanatory.
:returns: The jiggered bar.
The additional parameters are passed directly into
:meth:`.get_content`. Note: the `url` parameter cannot be
altered.
""".format(self.EMBED_TEXT)
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(expected_doc, new_doc)
def test_additional_params(self):
doc = """Jiggers the bar
Jolly important.
:params foo: Self explanatory.
:returns: The jiggered bar.
The additional parameters are passed directly into
:meth:`.get_content`. Note: the `url` parameter cannot be
altered.
"""
expected_doc = """Jiggers the bar
Jolly important.
{}
:params foo: Self explanatory.
:returns: The jiggered bar.
The additional parameters are passed directly into
:meth:`.get_content`. Note: the `url` parameter cannot be
altered.
""".format(self.embed_text)
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, expected_doc)
def test_multi_liner(self):
doc = """Jiggers the bar
Only run if foo is instantiated.
"""
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(doc + self.EMBED_TEXT + "\n\n", new_doc)
def test_multi_liner(self):
doc = """Jiggers the bar
Only run if foo is instantiated.
"""
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(doc + self.EMBED_TEXT + "\n\n", new_doc)
def test_multi_liner(self):
doc = """Jiggers the bar
Only run if foo is instantiated.
"""
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, doc + self.embed_text + "\n\n")
def test_multi_liner(self):
doc = """Jiggers the bar
Only run if foo is instantiated.
"""
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, doc + self.embed_text + "\n\n")
def test_single_plus_params(self):
doc = """Jiggers the bar
:params foo: Self explanatory.
"""
expected_doc = """Jiggers the bar
{}
:params foo: Self explanatory.
""".format(self.embed_text)
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, expected_doc)
def test_single_plus_params(self):
doc = """Jiggers the bar
:params foo: Self explanatory.
"""
expected_doc = """Jiggers the bar
{0}
:params foo: Self explanatory.
""".format(self.EMBED_TEXT)
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(expected_doc, new_doc)
def test_single_plus_params(self):
doc = """Jiggers the bar
:params foo: Self explanatory.
"""
expected_doc = """Jiggers the bar
{}
:params foo: Self explanatory.
""".format(self.embed_text)
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, expected_doc)
def test_single_plus_params(self):
doc = """Jiggers the bar
:params foo: Self explanatory.
"""
expected_doc = """Jiggers the bar
{0}
:params foo: Self explanatory.
""".format(self.EMBED_TEXT)
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(expected_doc, new_doc)
def test_multi_plus_params(self):
doc = """Jiggers the bar
Jolly importment.
:params foo: Self explanatory.
:returns: The jiggered bar.
"""
expected_doc = """Jiggers the bar
Jolly importment.
{}
:params foo: Self explanatory.
:returns: The jiggered bar.
""".format(self.embed_text)
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, expected_doc)
def test_multi_plus_params(self):
doc = """Jiggers the bar
Jolly importment.
:params foo: Self explanatory.
:returns: The jiggered bar.
"""
expected_doc = """Jiggers the bar
Jolly importment.
{0}
:params foo: Self explanatory.
:returns: The jiggered bar.
""".format(self.EMBED_TEXT)
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(expected_doc, new_doc)
def test_multi_plus_params(self):
doc = """Jiggers the bar
Jolly importment.
:params foo: Self explanatory.
:returns: The jiggered bar.
"""
expected_doc = """Jiggers the bar
Jolly importment.
{}
:params foo: Self explanatory.
:returns: The jiggered bar.
""".format(self.embed_text)
new_doc = decorators._embed_text(doc, self.embed_text)
self.assertEqual(new_doc, expected_doc)
def test_multi_plus_params(self):
doc = """Jiggers the bar
Jolly importment.
:params foo: Self explanatory.
:returns: The jiggered bar.
"""
expected_doc = """Jiggers the bar
Jolly importment.
{0}
:params foo: Self explanatory.
:returns: The jiggered bar.
""".format(self.EMBED_TEXT)
new_doc = _embed_text(doc, self.EMBED_TEXT)
self.assertEqual(expected_doc, new_doc)
def test_one_liner(self):
new_doc = decorators._embed_text("Returns something cool",
self.embed_text)
self.assertEqual(new_doc,
"Returns something cool\n\n" + self.embed_text)
def test_one_liner(self):
new_doc = decorators._embed_text("Returns something cool",
self.embed_text)
self.assertEqual(new_doc,
"Returns something cool\n\n" + self.embed_text)
def test_no_docstring(self):
new_doc = decorators._embed_text(None, self.embed_text)
self.assertEqual(new_doc, self.embed_text)
def test_no_docstring(self):
new_doc = _embed_text(None, self.EMBED_TEXT)
self.assertEqual(new_doc, self.EMBED_TEXT)
def test_one_liner(self):
new_doc = _embed_text("Returns something cool", self.EMBED_TEXT)
self.assertEqual("Returns something cool\n\n" + self.EMBED_TEXT,
new_doc)
def test_one_liner(self):
new_doc = _embed_text("Returns something cool", self.EMBED_TEXT)
self.assertEqual("Returns something cool\n\n" + self.EMBED_TEXT,
new_doc)
def test_no_docstring(self):
new_doc = _embed_text(None, self.EMBED_TEXT)
self.assertEqual(new_doc, self.EMBED_TEXT)
def test_no_docstring(self):
new_doc = decorators._embed_text(None, self.embed_text)
self.assertEqual(new_doc, self.embed_text)
