fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
6dff0205b7
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:07 +03:00
6245cb3c01
Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
...
This affects documentation, code comments, and a debugging messages.
2016-04-15 02:14:19 +00:00
adeffcc2f9
Closes #26444 : typo fixes.
2016-02-26 19:13:47 +01:00
d21e0b52f1
Issue #25161 : Add full stops in documentation; patch by Takase Arihiro
2015-10-10 10:36:22 +00:00
eca0445733
Issue #24079 : Improve description of the text and tail attributes for
...
ElementTree Element objects. Initial patch by Martin Panter.
2015-08-17 22:11:17 -04:00
c43a666ba2
Issue #23729 : Improve docs for ElementTree namespace parsing
2015-03-30 20:29:28 -07:00
f6e31b79a8
Issue 23729: Document ElementTree namespace handling and fix an omission in the XPATH predicate table.
2015-03-22 15:29:09 -07:00
b7354a65ce
Fixing broken links in doc, part 4: some more breaks and redirects
2014-10-29 10:57:37 +01:00
0bd22d4277
Issue #20375 : Clarify ET's parsing of comments and processing instructions.
...
Based on patch by Nikolaus Rath.
2014-04-03 06:14:38 -07:00
1e1e601bd1
Minor readability improvement.
2014-03-29 11:50:08 -07:00
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
303718c3d7
Fix empty strings to empty bytes objects.
2014-02-06 21:11:33 +02:00
5e028ae09e
Fix empty strings to empty bytes objects.
2014-02-06 21:10:41 +02:00
410d320703
whatsnew: XMLPullParser, plus some doc updates.
...
I was confused by the text saying that read_events "iterated", since it
actually returns an iterator (that's what a generator does) that the
caller must then iterate. So I tidied up the language. I'm not sure
what the sentence "Events provided in a previous call to read_events()
will not be yielded again." is trying to convey, so I didn't try to fix that.
Also fixed a couple more news items.
2014-01-04 23:52:50 -05:00
575fb31955
shelf in with stmt, fish/csh in venv, ElementTree short_empty_elements keyword.
...
Also added versionadded for for fish/csh, fixed indentation of versionadded
for ElementTree.write, and make the behavior of shelf as a context manager
explicit in the docs.
2013-12-25 23:21:03 -05:00
2915dd7103
Issue #19452 : Clarify the documentation of iterparse w.r.t. events argument.
...
In 3.3 iterparse accepts a tuple in events (the C accelerator enforces this).
This limitation was lifted in Python 3.4
2013-10-31 05:53:39 -07:00
834a73bf4f
merge with 3.3
2013-10-06 09:23:19 +02:00
bdaee3ac95
Fix: Element.text is an attribute, not a method (report by Cameron Laird on docs@)
2013-10-06 09:23:03 +02:00
4cc2afa0ec
Close #18990 : remove root attribute from XMLPullParser
...
- this was an internal implementation detail for iterparse
- this has been changed to use a new private method instead
- XMLPullParser.close docs are now more explicit about not
returning a root element and instead direct users towards
read_events
- also added missing docstrings and clarified some details
related to exactly *when* events are consumed from the
internal queue
(Initial patch by Stefan Behnel)
2013-09-28 23:50:35 +10:00
2c68e300e5
Fix XMLPullParser documentation to say "non-blocking" instead of "asynchronous".
...
The latter is more ambiguous.
Related to issue #17741
2013-08-31 07:37:23 -07:00
b586934f0e
Issue #17741 : Rename IncrementalParser and its methods.
...
The new names are hopefully more descriptive and consistent. If you feel you
don't agree with this change, *please* read issue 17741 first - there's a lot of
discussion in there.
2013-08-30 05:51:20 -07:00
a8c2a8aa8d
Issue #18760 : Improved cross-references in the xml package.
2013-08-29 10:29:30 +03:00
15e6590774
Issue #18760 : Improved cross-references in the xml package.
2013-08-29 10:28:44 +03:00
c020e7f8cb
Merge doc fix from 3.3
2013-08-25 15:30:39 -07:00
bf8ab77f94
Update XMLParser.close documentation and fix formatting.
...
Using ``method`` markup because the method is on a callback object, not an
explicitly documented method. :meth: markup creates links within the current
class which is incorrect.
In addition, indent the paragraph correctly.
2013-08-25 15:27:36 -07:00
74eba65fb6
Fix markup in elementtree docs.
2013-08-26 01:05:57 +03:00
bfd78370a5
Clarify the documentation of XMLParser.close
...
The return value of close() is not always a toplevel element. It depends on
what the underlying target returns. By default, TreeBuilder returns the
toplevel document element.
2013-08-24 15:11:44 -07:00
c4216ab92b
Issue #17902 : Clarify doc of ElementTree.iterparse and IncrementalParser
...
Based on patch by Aaron Oakley
2013-08-03 18:55:10 -07:00
ca97fd3053
Issue #17902 : Clarify doc of ElementTree.iterparse
2013-08-03 18:52:32 -07:00
fb625448f8
Clarify docs too: events can be any sequence (not that the C code supports it)
2013-05-19 09:09:24 -07:00
3bdead1113
Add some documentation for IncrementalParesr
2013-04-20 09:06:27 -07:00
10e0af8493
Fix trailing whitespace
2013-04-20 05:54:29 -07:00
ab2a76c8a8
Update ET documentation reprhasing the mention of the new IncrementalParser in
...
the doc for iterparse.
2013-04-20 05:53:50 -07:00
5b235d0923
Issue #17741 : Add ElementTree.IncrementalParser, an event-driven parser for non-blocking applications.
2013-04-18 19:37:06 +02:00
1bab7134a8
Merge with 3.3.
2013-03-28 13:28:55 +01:00
44ea77bd81
Closes #4159 : add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text.
2013-03-28 13:28:44 +01:00
9869e60dc2
Issue 17538: Document XML vulnerabilties
2013-03-26 17:48:28 +01:00
768f6a5360
Issue 17538: Document XML vulnerabilties
2013-03-26 17:47:23 +01:00
7380a67267
Issue 17538: Document XML vulnerabilties
2013-03-26 17:35:55 +01:00
7343cb0790
Issue #11367 : fix documentation of some find* methods in ElementTree
2013-03-12 06:01:22 -07:00
9e189f0a28
Cleanup the docs ElementTree a bit.
2013-01-13 22:24:27 +02:00
f1b045f417
Describe the default_namespace parameter of ElemetTree.write.
2013-01-13 22:04:43 +02:00
03530b980e
Describe the default_namespace parameter of ElemetTree.write.
2013-01-13 21:58:04 +02:00
e9af827fb1
Cleanup the docs ElementTree a bit and describe the default_namespace parameter. In the code, replace the old outdated Doxygen-ish comment above ElementTree.write by a proper docstring.
2013-01-13 06:27:51 -08:00
a9a2ef5550
Close #14377 : Add a new parameter to ElementTree.write and some module-level
...
serialization functions - short_empty_elements. It controls how elements
without contents are emitted.
Patch by Serhiy Storchaka. Feature initially proposed by Ariel Poliak.
2013-01-13 06:04:43 -08:00
831893a68e
Issue #16082 : clarify the documentation of tostring[list] saying that it may generate a bytestring, depending on the given encoding.
2012-10-09 07:18:16 -07:00
323a43af06
Issue #12322 : clarify xpath reference for cases where the path reaches ancestors of the start element. Also add missing markup for a None. Thanks to patrick vrijlandt and Mike Hoy for the report and initial patches.
2012-10-09 06:46:33 -07:00
a1b0f6d9be
Issue #15586 : fix prompts in some documentation examples
2012-08-18 05:42:22 +03:00
Terry Jan Reedy
Serhiy Storchaka
Martin Panter
Georg Brandl
Ned Deily
Raymond Hettinger
Eli Bendersky
Larry Hastings
R David Murray
Nick Coghlan
Ezio Melotti
Antoine Pitrou
Christian Heimes