Browse files

Adding minimal module docstrings for the deprecated Bio.Writers/Bio.w…

…riters.* framework
  • Loading branch information...
1 parent 7a34d63 commit fd2e06b7fc91b7bd6241f71fe0ddc4de88bdfd76 @peterjc peterjc committed Sep 22, 2008
View
9 Bio/Writer.py
@@ -1,7 +1,10 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
+
import warnings
-warnings.warn("Bio.Writer was deprecated, as any Biopython modules that used "\
- +"it have been deprecated. If you do use this module, please "\
- +"get in touch via the Biopython mailing list or bugzilla.")
+warnings.warn("Bio.Writer and Bio.writer.* are deprecated. If you do use"\
+ +" these modules, please get in touch via the mailing list or"\
+ +" bugzilla to avoid their permanent removal from Biopython.", \
+ DeprecationWarning)
class Writer:
def __init__(self, outfile):
View
1 Bio/writers/SeqRecord/__init__.py
@@ -1 +1,2 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
# This is a Python module.
View
1 Bio/writers/SeqRecord/embl.py
@@ -1,3 +1,4 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
# Not clear on the distinction, if any, between 'embl' and 'embl/65'. This
# code might apply to either or both.
View
1 Bio/writers/SeqRecord/empty.py
@@ -1,3 +1,4 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
from Bio import Writer
class WriteEmpty(Writer.Writer):
View
1 Bio/writers/SeqRecord/fasta.py
@@ -1,3 +1,4 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
from Bio import Writer
class WriteFasta(Writer.Writer):
View
2 Bio/writers/__init__.py
@@ -1 +1,3 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
# This is a Python module.
+# (there are more files underneath this directory)
View
4 DEPRECATED
@@ -20,6 +20,10 @@ Bio.builders
============
Part of the Martle/Mindy infrastructure, this was deprecated in Release 1.49
+Bio.Writer and Bio.writers
+==========================
+Deprecated in Release 1.48
+
Bio.MetaTool
============
Deprecated in Release 1.48, this was a parser from the output of MetaTool 3.5

0 comments on commit fd2e06b

Please sign in to comment.