From ff3da230ffed972c2e295c071aa7b048ac6db96f Mon Sep 17 00:00:00 2001 From: Stefan Bienert <stefan.bienert@unibas.ch> Date: Fri, 15 Jun 2012 14:42:42 +0200 Subject: [PATCH] Fixing BZDNG-365, wrote in the documentation what is really happening, even if we don't like it. --- modules/seq/base/doc/seq.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/seq/base/doc/seq.rst b/modules/seq/base/doc/seq.rst index e84cfe674..99f4c6b73 100644 --- a/modules/seq/base/doc/seq.rst +++ b/modules/seq/base/doc/seq.rst @@ -65,14 +65,16 @@ The SequenceHandle .. function:: CreateSequence(name, sequence) Create a new :class:`SequenceHandle` with the given name and sequence. - + :param name: name of the sequence :type name: str :param sequence: String of characters representing the sequence. Only - alphanumerical characters and '-' are allowed. + 'word' characters (no digits), '?', '-' and '.' are allowed. In an + upcoming release, '?' and '.' will also be forbidden so its best to + translate those to 'X' or '-'. :type sequence: str :raises InvalidSequence: When the sequence string contains forbidden - characters, that is anything that is not alphanumeric or a hyphen. + characters. In the future, '?' and '.' will also raise this exception. .. class:: SequenceHandle -- GitLab