Show More
@@ -476,7 +476,8 b' def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:' | |||||
476 | completions: Iterator[Completion] |
|
476 | completions: Iterator[Completion] | |
477 | iterator over the completions to rectify |
|
477 | iterator over the completions to rectify | |
478 |
|
478 | |||
479 |
|
479 | Notes | ||
|
480 | ----- | |||
480 | :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though |
|
481 | :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though | |
481 | the Jupyter Protocol requires them to behave like so. This will readjust |
|
482 | the Jupyter Protocol requires them to behave like so. This will readjust | |
482 | the completion to have the same ``start`` and ``end`` by padding both |
|
483 | the completion to have the same ``start`` and ``end`` by padding both | |
@@ -1422,8 +1423,8 b' class IPCompleter(Completer):' | |||||
1422 | text : str |
|
1423 | text : str | |
1423 | text to complete |
|
1424 | text to complete | |
1424 |
|
1425 | |||
1425 |
|
|
1426 | Notes | |
1426 |
----- |
|
1427 | ----- | |
1427 |
|
1428 | |||
1428 | If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion` |
|
1429 | If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion` | |
1429 | object containing a string with the Jedi debug information attached. |
|
1430 | object containing a string with the Jedi debug information attached. | |
@@ -1874,8 +1875,11 b' class IPCompleter(Completer):' | |||||
1874 |
|
1875 | |||
1875 | Yields |
|
1876 | Yields | |
1876 | ------ |
|
1877 | ------ | |
1877 |
|
|
1878 | Completion | |
1878 |
|
1879 | |||
|
1880 | ||||
|
1881 | Notes | |||
|
1882 | ----- | |||
1879 |
|
1883 | |||
1880 | The cursor on a text can either be seen as being "in between" |
|
1884 | The cursor on a text can either be seen as being "in between" | |
1881 | characters or "On" a character depending on the interface visible to |
|
1885 | characters or "On" a character depending on the interface visible to | |
@@ -2024,19 +2028,19 b' class IPCompleter(Completer):' | |||||
2024 |
|
2028 | |||
2025 | Parameters |
|
2029 | Parameters | |
2026 | ---------- |
|
2030 | ---------- | |
2027 |
|
|
2031 | text : string, optional | |
2028 |
|
|
2032 | Text to perform the completion on. If not given, the line buffer | |
2029 |
|
|
2033 | is split using the instance's CompletionSplitter object. | |
2030 |
|
2034 | |||
2031 |
|
|
2035 | line_buffer : string, optional | |
2032 |
|
|
2036 | If not given, the completer attempts to obtain the current line | |
2033 |
|
|
2037 | buffer via readline. This keyword allows clients which are | |
2034 |
|
|
2038 | requesting for text completions in non-readline contexts to inform | |
2035 |
|
|
2039 | the completer of the entire text. | |
2036 |
|
2040 | |||
2037 |
|
|
2041 | cursor_pos : int, optional | |
2038 |
|
|
2042 | Index of the cursor in the full line buffer. Should be provided by | |
2039 |
|
|
2043 | remote frontends where kernel has no access to frontend state. | |
2040 |
|
2044 | |||
2041 | Returns |
|
2045 | Returns | |
2042 | ------- |
|
2046 | ------- | |
@@ -2047,7 +2051,8 b' class IPCompleter(Completer):' | |||||
2047 | A list of completion matches. |
|
2051 | A list of completion matches. | |
2048 |
|
2052 | |||
2049 |
|
2053 | |||
2050 |
|
|
2054 | Notes | |
|
2055 | ----- | |||
2051 |
|
2056 | |||
2052 | This API is likely to be deprecated and replaced by |
|
2057 | This API is likely to be deprecated and replaced by | |
2053 | :any:`IPCompleter.completions` in the future. |
|
2058 | :any:`IPCompleter.completions` in the future. |
General Comments 0
You need to be logged in to leave comments.
Login now