##// END OF EJS Templates
Fix wording in docstrings
Brandon T. Willard -
Show More
@@ -67,8 +67,8 b' Experimental'
67 67
68 68 Starting with IPython 6.0, this module can make use of the Jedi library to
69 69 generate completions both using static analysis of the code, and dynamically
70 inspecting multiple namespaces. Jedi is an autocompletion and static analysis
71 for Python. The APIs attached to this new mechanism is unstable and will
70 inspecting multiple namespaces. Jedi is an autocompletion and static analysis
71 for Python. The APIs attached to this new mechanism is unstable and will
72 72 raise unless use in an :any:`provisionalcompleter` context manager.
73 73
74 74 You will find that the following are experimental:
@@ -185,11 +185,11 b" def provisionalcompleter(action='ignore'):"
185 185 """
186 186
187 187
188 This contest manager has to be used in any place where unstable completer
188 This context manager has to be used in any place where unstable completer
189 189 behavior and API may be called.
190 190
191 191 >>> with provisionalcompleter():
192 ... completer.do_experimetal_things() # works
192 ... completer.do_experimental_things() # works
193 193
194 194 >>> completer.do_experimental_things() # raises.
195 195
@@ -198,12 +198,11 b" def provisionalcompleter(action='ignore'):"
198 198 By using this context manager you agree that the API in use may change
199 199 without warning, and that you won't complain if they do so.
200 200
201 You also understand that if the API is not to you liking you should report
202 a bug to explain your use case upstream and improve the API and will loose
203 credibility if you complain after the API is make stable.
201 You also understand that, if the API is not to your liking, you should report
202 a bug to explain your use case upstream.
204 203
205 We'll be happy to get your feedback , feature request and improvement on
206 any of the unstable APIs !
204 We'll be happy to get your feedback, feature requests, and improvements on
205 any of the unstable APIs!
207 206 """
208 207 with warnings.catch_warnings():
209 208 warnings.filterwarnings(action, category=ProvisionalCompleterWarning)
@@ -1138,7 +1137,7 b' class IPCompleter(Completer):'
1138 1137
1139 1138 def all_completions(self, text) -> List[str]:
1140 1139 """
1141 Wrapper around the completions method for the benefit of emacs.
1140 Wrapper around the completion methods for the benefit of emacs.
1142 1141 """
1143 1142 prefix = text[:text.rfind(".") + 1]
1144 1143 with provisionalcompleter():
@@ -1557,7 +1556,7 b' class IPCompleter(Completer):'
1557 1556 argMatches.append(u"%s=" %namedArg)
1558 1557 except:
1559 1558 pass
1560
1559
1561 1560 return argMatches
1562 1561
1563 1562 def dict_key_matches(self, text):
@@ -2067,7 +2066,7 b' class IPCompleter(Completer):'
2067 2066 self.matches = _matches
2068 2067
2069 2068 return text, _matches, origins, completions
2070
2069
2071 2070 def fwd_unicode_match(self, text:str) -> Tuple[str, list]:
2072 2071 if self._names is None:
2073 2072 self._names = []
@@ -2086,7 +2085,7 b' class IPCompleter(Completer):'
2086 2085 return s, candidates
2087 2086 else:
2088 2087 return '', ()
2089
2088
2090 2089 # if text does not start with slash
2091 2090 else:
2092 2091 return u'', ()
General Comments 0
You need to be logged in to leave comments. Login now