Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(31)

Unified Diff: doxypypy/doxypypy/test/sample_rawdocstring.py

Issue 1574883002: add doxypypy and py_filter so this will turn google style (Closed) Base URL: https://chromium.googlesource.com/native_client/pnacl-subzero.git@master
Patch Set: Created 4 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: doxypypy/doxypypy/test/sample_rawdocstring.py
diff --git a/doxypypy/doxypypy/test/sample_rawdocstring.py b/doxypypy/doxypypy/test/sample_rawdocstring.py
new file mode 100644
index 0000000000000000000000000000000000000000..7e2db3b5ecaa22f6444b88686f3861859d230887
--- /dev/null
+++ b/doxypypy/doxypypy/test/sample_rawdocstring.py
@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+# encoding: utf-8
+r"""
+Raw docstrings sample module.
+
+Tests support for raw docstrings, which are necessary when docstrings contain
+escape sequences.
+
+E.g. TeX-maths:
+@f[
+ \exp(x) = \sum_{k=0}^{\infty} \frac{x^k}{k!}
+@f]
+
+Related to issue #8 [1].
+
+[1]: https://github.com/Feneric/doxypypy/issues/8
+"""
+
+
+def sqrt4():
+ r"""Calculate the square-root of four.
+
+ Returns:
+ @f$ \sqrt{4} @f$.
+ """
+ return 2
+
+
+def invert(x):
+ r"""Invert the given number.
+
+ Args:
+ x: Invert this number \f$x\f$.
+
+ Returns:
+ @f$\frac{1}{x}@f$.
+ """
+ return 1/x
+
+
+class Polynomial(object):
+ r"""Stores a polynomial.
+
+ Here, a polynomial is defined as a finite series of the form
+ @f[
+ a_0 + a_1 x + a_2 x^2 + \cdots + a_N x^N,
+ @f]
+ where \f$ a_k \f$, for \f$k=0,\ldots,N\f$, are real coefficients, and
+ \f$N\f$ is the degree of the polynomial.
+
+ Attributes:
+ coefficients: A list of coefficients.
+ """
+
+ def __init__(self, coefficients):
+ r"""Initialize a polynomial instance.
+
+ Args:
+ coefficients: A list of coefficients. Beginning with \f$a_0\f$,
+ and ending with \f$a_N\f$.
+ """
+ self.coefficients = coefficients
+
+
+ def find_roots(self):
+ r"""Find the real roots of the polynomial.
+
+ I.e. all real numbers @f$ x_i @f$ for which
+ \f[
+ a_0 + a_1 x_i + a_2 {x_i}^2 + \cdots + a_N {x_i}^N = 0.
+ \f]
+
+ Returns:
+ A list of all real roots, or an empty list if there are none.
+
+ \todo Implement this method.
+ """
+ pass
+
+
+def main():
+ """Demonstrate polynomial class."""
+ p = Polynomial([0, 1, 0, 2])
+
+ print(p.coefficients)
+
+
+if __name__ == '__main__':
+ main()

Powered by Google App Engine
This is Rietveld 408576698