Skip to content

Commit 467799c

Browse files
committed
Upgrading directions from 2.0.0 - classname format requirements.
1 parent 8a626db commit 467799c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/upgrading.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,24 @@ Contents:
2222
.. contents::
2323
:local:
2424

25+
.. index:: Upgrading; 1.6.x to 2.x.x
26+
27+
Migrating from 2.0.0 to 2.x.x
28+
=============================
29+
30+
Classname Format Enforced
31+
=========================
32+
33+
Check schema.py and look at all Class(), IssueClass(), FileClass()
34+
calls. The second argument is the classname. All classnames must:
35+
36+
* start with an alphabetic character
37+
* consist of alphanumerics and '_'
38+
* not end with a digit
39+
40+
this was not enforced before. Using non-standard classnames could lead
41+
to other issues.
42+
2543
.. index:: Upgrading; 1.6.x to 2.0.0
2644

2745
Migrating from 1.6.X to 2.0.0

0 commit comments

Comments
 (0)