Commit Graph

25 Commits

Author SHA1 Message Date
Dave Halter
91499565a9 Specially crafted docstrings sometimes lead to errors, fixes #1103 2018-04-25 21:04:05 +02:00
Simon Ruggier
338ea42ed9 docstrings: fix "Sphinx param with type" pattern (#807)
* docstrings: fix "Sphinx param with type" pattern

Previously, the pattern only matched if the parameter description
followed on the same line, like so:

    :param type foo: A param named foo.

However, it's also valid for the parameter description to be wrapped
onto the next line, like so:

    :param type foo:
        A param named foo.

This change updates the pattern to match the second example as well, and
adds a test to verify this behaviour.

Fixes #806.

* Add Simon Ruggier to the AUTHORS file
2017-04-27 20:05:48 +02:00
Dave Halter
524a13ba26 Proof that docstring inference is working even on renamed imports. Fixes #507. 2016-07-31 12:14:44 +02:00
Dave Halter
2b4b5f069b Docstring should also be evaluated in class definitions. Fixes #631. 2016-07-30 14:18:20 +02:00
Dave Halter
a9d3df9b5e Replace the threading.Thread tests in docstrings with random.Random tests, because that might work smother in the travis tests. Don't know why it broke there. 2015-04-09 16:17:16 +02:00
Dave Halter
22b288fc73 Change docstring test function names, so that dynamic param completion doesn't interfere (especially because some of those files still generate parser errors). 2014-11-20 00:35:48 +01:00
Dave Halter
cba100a801 test for #414 which doesn't seem to be failing anymore. 2014-08-04 16:08:47 +02:00
Dave Halter
332a16a27e elements in tuples/lists in docstrings were not executed. 2014-07-31 17:13:56 +02:00
Dave Halter
d09279e0ad change tests that provided wrong instance information 2014-07-31 15:16:24 +02:00
Pawel Palucki
d359f5d043 Sphinx oneline param type declaration feature
allows for type definition in ":param keyword"
2014-07-26 22:15:56 +02:00
Dave Halter
9b3b28f185 use defaultdict instead of OrderedDict for testing purposes, since OrderedDict is not supported in Python 2.6 2014-03-31 12:18:53 +02:00
Dave Halter
1a1d4f5576 test: docstring sphinx type returns don't work like the docstring param stuff 2014-03-27 21:02:07 +01:00
Dave Halter
2f71bd4e63 test for multiple docstring imports with complicated lists and tuples 2014-03-27 20:05:39 +01:00
Dave Halter
eea2d0c8c5 param docstrings cleaned up - #370 2014-03-27 19:51:35 +01:00
Dave Halter
196fcdb4df docstring param hints not working properly - test for #370 2014-03-26 16:47:54 +01:00
David Halter
9c53de5034 add empty return type test 2013-07-23 15:35:37 +02:00
David Halter
90202b2ad6 tests for failing docstrings 2013-07-23 15:11:14 +02:00
David Halter
ebc8d4c04c docstring test with statement docstrings (failed until now, worked only for specific cases) 2013-07-19 12:47:38 +02:00
David Halter
2e0d0bb4f5 test for #210 2013-05-04 13:44:15 +04:30
Takafumi Arakaki
0cbbb17a82 Add tests in completion/docstring.py 2013-01-30 21:23:04 +01:00
Yakov Borevich
3b412c72e9 Remove google docstrings support. Updates #40 2012-12-28 10:09:03 +04:00
Yakov Borevich
c7cf7b6dc7 Fix complex param parsing in docstrings. 2012-12-28 10:07:51 +04:00
Yakov Borevich
502c643c73 Return types for docstrings 2012-12-27 19:30:40 +04:00
Yakov Borevich
a7f7d8ff9f Add tests for epydoc formated dosctring 2012-12-27 14:59:42 +04:00
David Halter
e057387910 added docstring tests (forgot to add them a while ago), important for #87 2012-12-26 23:08:34 +01:00