Skip to content

Commit abcba09

Browse files
Update doc (changelog) for version 2.2
1 parent d42f3c5 commit abcba09

4 files changed

Lines changed: 139 additions & 115 deletions

File tree

CHANGELOG.rst

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
2.2.0
2+
-----
3+
4+
New features:
5+
- automatically fold import statements when opening document
6+
- improved GoToAssignment mode (now highlighting word only if a jump is
7+
possible)
8+
- SH: highlight cls pseudo keyword
9+
- SH: highlight builtin methods (__init__, __call__, __add__,...)
10+
- add support for auto completion of classmethods
11+
- improve defined_names worker to work recursively (now able to catch
12+
nested classes)
13+
14+
Fixed bugs:
15+
- fix confusing convention: now both line numbers and column numbers starts
16+
from 0
17+
- fix editor not having focus when clicking on an item in the symbol
18+
browser panel
19+
- fix regex in PyInteractiveConsole
20+
- fix performance issue with import region folding
21+
- fix performance issue with docstring folding
22+
- fix performance issue with auto indent
23+
- fix code completion tooltip: use description instead of full name
24+
- SH: fix highlighting of commented docstrings
25+
26+
2.1.0
27+
-----
28+
29+
New features:
30+
- code folding (with support for folding docstrings and imports)
31+
- new python syntax highlighter (based on the Spyder IDE PythonSH) with
32+
additional support for docstrings, decorators and self parameter.
33+
The new highlighter is a lot faster than the previous one and has a better
34+
docstring highlighting.
35+
- new PyInteractiveConsole for running python program. The new console has
36+
support for highlighting tracebakc and let you jump to the incriminated
37+
file with just one click.
38+
39+
Bug fixed:
40+
41+
- many bugs have been fixed in the auto indent mode
42+
- many small bugs have been fixed in QIdle
43+
- fix cursor position after comment/uncomment (Ctrl+/)
44+
45+
2.0.0
46+
-----
47+
48+
Too many things have change since 1.3.2 as the API has undergone some heavy
49+
refactoring.
50+
51+
1.3.2
52+
-----
53+
54+
New features:
55+
- add support for jedi 0.8 final which bring several minor enhancements
56+
57+
Fixed bugs:
58+
- fix a bug with boostrap.py
59+
60+
1.3.1
61+
-----
62+
63+
New features:
64+
65+
- the comments mode is now PEP8 compliant
66+
- the documentation panel now uses docutils to get an html representation
67+
of docstrings
68+
- QPythonCodeEdit now includes the file watcher mode
69+
- lots of improvements to the auto indent mode
70+
71+
Fixed bugs:
72+
73+
- Add support for jedi 0.8 (which has not been released yet, compatibility
74+
with jedi 0.7 has been kept)
75+
- many bug fixes to the auto indent mode
76+
77+
78+
1.3.0
79+
-----
80+
81+
Fixed bugs:
82+
83+
- more fixes to auto completion
84+
- fixes for auto indentation mode
85+
- fix type error in document layout parser.
86+
- Fix calltips when there is a closing parenthesis
87+
88+
89+
1.2.0
90+
-----
91+
92+
Fixed bugs:
93+
94+
- Fix various bugs with auto complete
95+
- Fix bugs with code completion in comments and strings
96+
- Fix for designer plugin
97+
98+
1.1.0
99+
-----
100+
101+
New features:
102+
- add the following new modes:
103+
- :class:`pyqode.python.PyAutoCompleteMode`
104+
- :class:`pyqode.python.CommentsMode`
105+
- :class:`pyqode.python.DocumentAnalyserMode`
106+
- :class:`pyqode.python.GoToAssignmentsMode`
107+
- add the following new panels:
108+
- :class:`pyqode.python.QuickDocPanel`
109+
- :class:`pyqode.python.SymbolBrowserPanel`
110+
- CodeCompletion: provides method to interact with the subprocess interpreter
111+
- CodeCompletion: preload hooks
112+
- Add :class:`pyqode.python.Boostrapper` class to help start the code completion with a list of modules to
113+
preload + example with a splash screen.
114+
115+
Fixed bugs:
116+
- Disable actions which depends on preload
117+
- Disable code completion in commente and strings
118+
- Fix highlighting in docstrings (highlighting was lost when there was an '=' in the docstring.
119+
120+
1.0.0
121+
-----
122+
123+
Initial development.

doc/source/changelog.rst

Lines changed: 1 addition & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -5,101 +5,4 @@ Change Log
55

66
These lists are not exhaustive.
77

8-
2.1.0
9-
-----
10-
11-
New features:
12-
- code folding (with support for folding docstrings and imports)
13-
- new python syntax highlighter (based on the Spyder IDE PythonSH) with
14-
additional support for docstrings, decorators and self parameter.
15-
The new highlighter is a lot faster than the previous one and has a better
16-
docstring highlighting.
17-
- new PyInteractiveConsole for running python program. The new console has
18-
support for highlighting tracebakc and let you jump to the incriminated
19-
file with just one click.
20-
21-
Bug fixed:
22-
23-
- many bugs have been fixed in the auto indent mode
24-
- many small bugs have been fixed in QIdle
25-
- fix cursor position after comment/uncomment (Ctrl+/)
26-
27-
2.0.0
28-
-----
29-
30-
Too many things have change since 1.3.2 as the API has undergone some heavy
31-
refactoring.
32-
33-
1.3.2
34-
-----
35-
36-
New features:
37-
- add support for jedi 0.8 final which bring several minor enhancements
38-
39-
Fixed bugs:
40-
- fix a bug with boostrap.py
41-
42-
1.3.1
43-
-----
44-
45-
New features:
46-
47-
- the comments mode is now PEP8 compliant
48-
- the documentation panel now uses docutils to get an html representation
49-
of docstrings
50-
- QPythonCodeEdit now includes the file watcher mode
51-
- lots of improvements to the auto indent mode
52-
53-
Fixed bugs:
54-
55-
- Add support for jedi 0.8 (which has not been released yet, compatibility
56-
with jedi 0.7 has been kept)
57-
- many bug fixes to the auto indent mode
58-
59-
60-
1.3.0
61-
-----
62-
63-
Fixed bugs:
64-
65-
- more fixes to auto completion
66-
- fixes for auto indentation mode
67-
- fix type error in document layout parser.
68-
- Fix calltips when there is a closing parenthesis
69-
70-
71-
1.2.0
72-
-----
73-
74-
Fixed bugs:
75-
76-
- Fix various bugs with auto complete
77-
- Fix bugs with code completion in comments and strings
78-
- Fix for designer plugin
79-
80-
1.1.0
81-
-----
82-
83-
New features:
84-
- add the following new modes:
85-
- :class:`pyqode.python.PyAutoCompleteMode`
86-
- :class:`pyqode.python.CommentsMode`
87-
- :class:`pyqode.python.DocumentAnalyserMode`
88-
- :class:`pyqode.python.GoToAssignmentsMode`
89-
- add the following new panels:
90-
- :class:`pyqode.python.QuickDocPanel`
91-
- :class:`pyqode.python.SymbolBrowserPanel`
92-
- CodeCompletion: provides method to interact with the subprocess interpreter
93-
- CodeCompletion: preload hooks
94-
- Add :class:`pyqode.python.Boostrapper` class to help start the code completion with a list of modules to
95-
preload + example with a splash screen.
96-
97-
Fixed bugs:
98-
- Disable actions which depends on preload
99-
- Disable code completion in commente and strings
100-
- Fix highlighting in docstrings (highlighting was lost when there was an '=' in the docstring.
101-
102-
1.0.0
103-
-----
104-
105-
Initial development.
8+
.. include:: /../../CHANGELOG.rst

doc/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ def __getattr__(cls, name):
7878
# built documents.
7979
#
8080
# The short X.Y version.
81-
version = '2.1'
81+
version = '2.2'
8282
# The full version, including alpha/beta/rc tags.
83-
release = '2.1.0'
83+
release = '2.2.0'
8484

8585
# The language for content autogenerated by Sphinx. Refer to documentation
8686
# for a list of supported languages.

doc/source/whats_new.rst

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,23 @@ accomplished, please visit the `issues page on github`_ and the
99
:doc:`changelog </changelog>`, respectively.
1010

1111

12-
2.1.0
12+
2.2.0
1313
-----
1414

15-
The 2.1 version adds the following new features:
15+
This is mainly a bug fix version but it introduces a possible backward
16+
incompatible change. We changed a confusing internal convention where line
17+
numbers are 1 based and column number 0 based. Now both line and column numbers
18+
are 0 based. This change has been done in order to make integrating pyqode
19+
in other application an easier task. This follow the Qt Text API convention.
20+
The only API concerned by this changed is the TextHelper API. If you were not
21+
using TextHelper, this change won't impact your code. Otherwise you will have
22+
to update all the line numbers arguments to be 0 based.
1623

17-
- code folding (with support for folding docstrings and imports)
18-
- new python syntax highlighter (based on the Spyder IDE PythonSH) with
19-
additional support for docstrings, decorators and self parameter.
20-
The new highlighter is a lot faster than the previous one and has a better
21-
docstring highlighting.
22-
- new PyInteractiveConsole for running python program. The new console has
23-
support for highlighting tracebakc and let you jump to the incriminated
24-
file with just one click.
24+
The only real new feature is caching of cursor position. We you re-open a document,
25+
pyqode will try to move the cursor to the last stored position.
2526

26-
As for every new version, the python auto indent modes has been vastly improved
27-
(with more than 20 new tests).
28-
29-
We also fixed quite a few bugs in QIdle and the comments mode has been
30-
improved.
27+
On top of that, we spend sometime polishing the widget and we added a few new
28+
signals and methods to the API.
3129

3230
Next Version
3331
------------

0 commit comments

Comments
 (0)