Keewis
1c388241b4
default to False and update the tests
2020-08-12 19:48:07 +02:00
Keewis
27c252ccba
only preprocess if the preprocessor is enabled
2020-08-10 13:04:21 +02:00
Takeshi KOMIYA
a4996f9054
Fix #7780 : napoleon: multiple params declaration was wrongly recognized
...
So far, napoleon converts multiple paramaters declrarations to single
paramaeter fields (`:param:` and `:type:`) unexpectedly. As a result,
the output seems broken.
This converts it to multiple parameter fields (a pair of field for each
parameter declration) to build parameter successfully.
Note: The conversion rule is available only when napoleon_use_params=True.
2020-08-07 23:46:55 +09:00
Takeshi KOMIYA
99e65a59be
napoleon: Fix a broken test (refs: #8049 )
...
Fix a testcase that added just before #8049 merged.
2020-08-07 23:44:32 +09:00
Takeshi KOMIYA
62a6df8f3c
Merge pull request #8049 from keewis/type-preprocessing-without-use_param
...
enable type preprocessing without use_param
2020-08-07 23:37:22 +09:00
Keewis
849d3c18a7
remove the syntax checks from the escape method and update the tests
2020-08-05 19:22:43 +02:00
Keewis
478ab44d7e
Merge branch '3.x' into escape-combined-args-kwargs
2020-08-04 18:38:03 +02:00
Keewis
47da37e1d9
make sure strings are not split using other delimiters
2020-08-04 12:28:30 +02:00
Keewis
fbad78d08f
check that a "default <obj>" notation works with xrefs
2020-08-04 12:21:00 +02:00
Keewis
cac6d1787d
preprocess even with napoleon_use_param = False
2020-08-04 10:43:31 +02:00
Keewis
6be806b3c8
check that floats and complex numbers are detected as literals
2020-08-01 14:20:04 +02:00
Keewis
92e9cd488c
use a regex to decide whether to postprocess a token starting with default
2020-08-01 13:38:38 +02:00
Keewis
b353dfed7b
properly link ... to Ellipsis
2020-07-31 17:44:04 +02:00
Keewis
31809b3041
add tests for referencing ellipsis objects
2020-07-29 22:30:02 +02:00
Keewis
e39c1a8d6a
add more delimiters so describing mappings becomes possible
2020-07-29 22:29:03 +02:00
Keewis
05bf00bd4c
make the postprocessing a bit more robust and add tests
2020-07-29 22:23:51 +02:00
Keewis
0e5964dad9
move the misplaced GoogleDocstring test to the appropriate test class
2020-07-29 02:34:17 +02:00
Keewis
58f84186e0
Merge branch '3.x' into escape-combined-args-kwargs
2020-07-25 15:15:06 +02:00
Keewis
ae35f81d3d
allow mapping to a long name
2020-07-21 17:13:41 +02:00
Keewis
9b425606e7
support pandas-style default spec by postprocessing tokens
2020-07-21 12:26:28 +02:00
Keewis
274d9fe4f9
don't try to generate test cases in code
2020-07-16 00:27:00 +02:00
Keewis
660b818636
add type hints and location information
2020-07-16 00:27:00 +02:00
Keewis
2b981b6abd
make sure singletons actually use :obj:
2020-07-16 00:27:00 +02:00
Keewis
fc43f494ac
add back the trailing whitespace
2020-07-16 00:27:00 +02:00
Keewis
4fc22cd0c4
use the dedent function imported at module-level
2020-07-16 00:27:00 +02:00
Keewis
f30c0cb9f6
rewrite the invalid token_type test to check the warnings
2020-07-16 00:27:00 +02:00
Keewis
4d0b4f2931
add back the trailing whitespace
2020-07-16 00:26:11 +02:00
Keewis
26855f92d8
also test invalid string tokens
2020-07-16 00:26:10 +02:00
Keewis
1140f7b26d
also check type specs without actual types
2020-07-16 00:26:10 +02:00
Keewis
d177e58999
reimplement the value set combination function using collections.deque
2020-07-16 00:26:10 +02:00
Keewis
866c822e11
move the warnings to token_type
2020-07-16 00:26:10 +02:00
Keewis
af6071e571
expect a warning instead of an error
2020-07-16 00:26:10 +02:00
Keewis
dc8c7ac9f8
update the integration test
2020-07-16 00:26:10 +02:00
Keewis
9835f1fff8
test that braces and quotes in strings work
2020-07-16 00:26:09 +02:00
Keewis
2882c3465a
fix the expected parameters section to match the current status
2020-07-16 00:22:56 +02:00
Keewis
fc70205fb4
get the type converter function to work, verified by new tests
2020-07-16 00:22:56 +02:00
Keewis
25937f745a
move tokenize_type_spec to its own function and add tests for it
2020-07-16 00:22:56 +02:00
Keewis
b1f43d2fff
use textwrap for a normal indentation depth
2020-07-16 00:19:58 +02:00
Keewis
a7bbedfbb7
add a test for the parameter type conversions
2020-07-16 00:19:22 +02:00
Keewis
467533ffe8
add tests to make sure the warning is raised
2020-07-13 15:49:03 +02:00
Takeshi KOMIYA
eb8f3b539a
Revert "ext.napoleon: Emit type annotations at the start of .. attribute::"
...
This reverts commit 9d7171899a .
2020-06-13 16:28:58 +09:00
Keewis
15b443c074
add a test for combined args and kwargs
2020-06-08 17:17:58 +02:00
Takeshi KOMIYA
a28c9ad842
Fix #7734 : napoleon: overescaped trailing underscore on attribute
2020-05-28 01:47:33 +09:00
Takeshi KOMIYA
1c3179300a
Merge pull request #7583 from eric-wieser/fix-napoleon
...
ext.napoleon: Emit type annotations at the start of `.. attribute::`
2020-05-02 12:33:59 +09:00
Eric Wieser
453fe55dc9
ext.napoleon: Do not consume colons within inline code
...
Fixes gh-7581
2020-04-30 08:57:24 +01:00
Eric Wieser
9d7171899a
ext.napoleon: Emit type annotations at the start of .. attribute::
2020-04-29 19:03:24 +01:00
Takeshi KOMIYA
89dd4bf438
Fix #6240 : napoleon: Attributes and Methods sections ignore :noindex: option
2020-03-21 18:54:44 +09:00
Takeshi KOMIYA
b14439ca48
Fix #6999 : napoleon: fails to parse tilde in :exc: role
2020-01-09 00:15:27 +09:00
Takeshi KOMIYA
eaf495c3c4
A happy new year!
2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
c4dfc7402e
Fix #6436 : napoleon: "Unknown target name" error
2019-06-09 00:23:18 +09:00