Skip to content

Commit cac899e

Browse files
committed
Extend docstring
1 parent 1783921 commit cac899e

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

src/biotite/structure/io/pdbx/encoding.pyx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,13 @@ class Encoding(_Component, metaclass=ABCMeta):
225225
-------
226226
decoded_data : ndarray
227227
The decoded data.
228+
229+
Warnings
230+
--------
231+
When overriding this method, do not omit bound checks with
232+
``@cython.boundscheck(False)`` or ``@cython.wraparound(False)``,
233+
since the file content may be invalid/malicious.
228234
"""
229-
# Important: Do not omit bound checks for decoding,
230-
# since the file content may be invalid/malicious.
231235
raise NotImplementedError()
232236

233237
def __str__(self):

0 commit comments

Comments
 (0)