# HG changeset patch # User Charlie Clark <charlie.clark@clark-consulting.eu> # Date 1427722905 -7200 # Mon Mar 30 15:41:45 2015 +0200 # Node ID 762c368eae42131cce0ffea2b1d4f48ea0fd5a11 # Parent 1f11070b87f399289b4645ad93e5fdf6232e65f8 Add note on performance. diff --git a/doc/index.rst b/doc/index.rst --- a/doc/index.rst +++ b/doc/index.rst @@ -5,6 +5,12 @@ It is pure Python and about twice as slow than lxml or other solutions. +Note on performance +------------------- + +There is one area where an optimisation for lxml will negatively affect the performance of et_xmfile: when using the `.element()` method on an xmlfile context manager. It is recommended not to use this, though the method is provided for code compatibility. + + Sample code: ++++++++++++ @@ -12,7 +18,7 @@ API Documentation ------------------- +----------------- .. toctree:: :maxdepth: 1