Commit Graph

571 Commits

Author SHA1 Message Date
Victor Stinner f6447e0065 doc: Suggest to hash(tuple of attr) rather than XOR
Issue #28383: __hash__ documentation recommends naive XOR to combine but this
is suboptimal. Update the doc to suggest to reuse the hash() method using a
tuple, with an example.
2016-12-19 13:15:35 +01:00
Serhiy Storchaka 0092bc7279 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:39 +02:00
Serhiy Storchaka ad13f338ce Issue #19795: Mark up None as literal text. 2016-10-19 16:29:10 +03:00
Martin Panter 8f1dd224e0 Issue #26462: Doc: avoid literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Martin Panter b362f75f6e Issue #25523: Correct "a" article to "an" article
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
to fix the grammar.
2015-11-02 03:37:02 +00:00
Martin Panter d51b0f2188 Issue #24314: Add links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Tommy Beadle 24b9e1a00d [Issue 15476] Make "code object" its own entry in the index 2016-06-02 19:26:51 -04:00
Martin Panter d5982d0433 Issue #23275: Backport empty square bracket assignment documentation fix 2016-06-08 12:44:30 +00:00
Serhiy Storchaka 12d547a80d Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 13:45:32 +03:00
Raymond Hettinger 167c81d5ed Issue #23986: Note that the in-operator for lists and tuples check identity before equality. 2016-04-26 00:59:16 -07:00
Serhiy Storchaka 838b1339e8 Remove redundant leading zeroes in PEP references. 2016-03-31 15:31:04 +03:00
Zachary Ware bf3b89782f Python for .NET has moved to Github.
Reported by Denis Akhiyarov on docs@
2016-02-03 22:05:46 -06:00
Robert Collins 311c8d63e5 Issue #24531: Document that encoding lines cannot follow non-comment lines.
Patch from Terry Reedy
2015-08-06 21:08:44 +12:00
Benjamin Peterson dbbc07c2ec the default is sys.maxsize not sys.maxint (closes #23645) 2015-03-13 14:32:31 -05:00
Ethan Furman 3700cc3ad6 Issue20467: clarify __init__'s role 2015-01-14 22:02:10 -08:00
Terry Jan Reedy f0f09b9470 Issue #23006: Improve the documentation and indexing of dict.__missing__.
Add an entry in the language datamodel special methods section.
Revise and index its discussion in the stdtypes mapping/dict section.
Backport the code example from 3.4.
2014-12-10 18:38:07 -05:00
Georg Brandl 97ae4660e1 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +01:00
Georg Brandl 06f3b3b98c Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Benjamin Peterson 867dc37822 remove link to the 'original package specification'; I doubt it's useful anymore (closes #22657) 2014-10-17 11:07:14 -04:00
Georg Brandl 8d867cb718 Closes #17057: fix grammar in old-style vs new-style class docs. 2014-10-06 17:46:43 +02:00
Terry Jan Reedy b10b8ead13 Issue 22465: grammar, number agreement. 2014-09-30 19:07:45 -04:00
Serhiy Storchaka ea217728c3 Issue #20643: Fixed references to the next() method (distinguish from the
next() function).
2014-09-05 23:34:12 +03:00
Benjamin Peterson 13056bff66 correct call grammar error (#3473) 2014-08-28 00:05:52 -04:00
Terry Jan Reedy a58b255a8e Issue #22243: fix except grammar in reference. 2014-08-23 19:29:40 -04:00
Benjamin Peterson e9314e4a3c remove confusing delete indexing (closes #21466) 2014-05-11 11:18:51 -07:00
Zachary Ware 4773b908b1 Add prompts to interactive example.
This makes it match the new example below, and allows Sphinx's
"hide the prompts and output" feature to work.
2014-05-06 09:18:17 -05:00
Zachary Ware 1512143ef0 Issue #21366: Document the fact that ``return`` in a ``finally`` clause
overrides a ``return`` in the ``try`` suite.
2014-05-06 09:07:13 -05:00
Terry Jan Reedy f3ae10e7ca Closes #21055: Index (augmented) assignment symbols. 2014-04-29 01:19:05 -04:00
Terry Jan Reedy cd3d741451 Closes 21048: Index 'as' in import and with statements. 2014-04-29 00:58:48 -04:00
R David Murray dd967efae9 #18628: clarify index entry for source file encoding declaration. 2014-04-16 21:57:38 -04:00
Benjamin Peterson b41299e498 note that the hash of an arbitrary object is only derived from its address (closes #21154)
Patch from Armin Rigo.
2014-04-04 09:58:13 -04:00
Mark Dickinson 383952d52c Issue #19683: Add __closure__ and other missing attributes to function docs. 2014-02-01 16:32:40 +00:00
Serhiy Storchaka 26d936a71e Issue #19795: Improved markup of True/False constants. 2013-11-29 12:16:53 +02:00
Serhiy Storchaka ad16b725bc Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:14 +03:00
Georg Brandl cff39b0120 Use "lambda expression" as preferred to "lambda form". 2013-10-06 10:26:58 +02:00
Benjamin Peterson b44c8619fe document that various functions that parse from source will interpret things as latin-1 (closes #18870) 2013-09-01 19:06:35 -04:00
Terry Jan Reedy 241f653b8a Remove repetition of string escapes note 1 at end of note 2. 2013-07-27 15:54:05 -04:00
Andrew Kuchling 67f84a78f0 #14878: add cross-reference to the yield statement.
(Backported from 3.x by Jan Duzinkiewicz.)
2013-05-09 20:55:22 -04:00
Georg Brandl e7fb7008ba The im_class of unbound class methods is actually not the same as im_self. 2013-04-14 11:53:36 +02:00
Georg Brandl 7a48a8b8c6 Clarify point in name mangling doc. 2013-04-14 10:13:42 +02:00
Georg Brandl 75da35747e Backport rev. 3ae74b361f53 to 2.7 branch. 2013-03-28 13:35:18 +01:00
Georg Brandl 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
Ezio Melotti 93324d7d9c Update suspicious ignore file. 2013-03-28 05:47:31 +02:00
Chris Jerdonek 32bbc1c396 Merge from 3.2: add links and index entries for "argument" and "parameter."
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:57:54 -08:00
Chris Jerdonek b43099464a Add additional links and index entries for "argument" and "parameter".
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:54:44 -08:00
Ezio Melotti 1be057673a #16677: merge with 3.2. 2012-12-25 15:46:58 +02:00
Ezio Melotti 9f929bb7df #16677: rename section header and fix markup. 2012-12-25 15:45:15 +02:00
Chris Jerdonek 2654b86e88 Link to "yield from" examples in yield documentation.
This commit also simplifies the more advanced "yield from" example and removes
unused function parameters.
2012-12-23 15:31:57 -08:00
Chris Jerdonek bb4e941c6d Add a str class entry to the "Text Sequence Type" section (issue #16209).
This commit also moves the documentation for the str built-in function to
the new class entry.  Links to :class:`str` now go to the class entry with
the string methods immediately afterwards.
2012-11-28 01:38:40 -08:00
Chris Jerdonek 777db2d838 Fix label in docs (from issue #13538). 2012-11-21 05:32:44 -08:00