Commit Graph

126 Commits

Author SHA1 Message Date
Andre Delfino 55e335d7d5 Remove empty Dictionaries section from programming FAQ (GH-12026) 2019-02-25 11:22:07 -05:00
Serhiy Storchaka 2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00
Andrés Delfino a378254186 closes bpo-33883: Mention type checkers in the FAQ. (GH-7760) 2018-09-10 22:12:41 -07:00
Noah Haasis 2707e41a5c bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)
Update the the signature in the code example to make `_cache` a keyword-only parameter.
2018-06-15 20:29:11 -07:00
Andrés Delfino 396ecb9c3e bpo-33799: Remove non-ordered dicts comments from FAQ 2018-06-08 15:38:07 +09:00
Sanyam Khurana 1b4587a246 bpo-25910: Fixes redirection from http to https (#4674) 2017-12-06 17:39:33 +01:00
Gregory P. Smith e9d978fd1b Fix a typo in the Programming FAQ. (#3230)
subobjects, not subobjecs.
2017-08-28 13:43:26 -07:00
Marco Buttu 909a6f626f bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
Senthil Kumaran 2950776d36 [merge from 3.5] - Issue27203 - Fix doctests Doc/faq/programming.rst.
Patch contributed by Jelle Zijlstra.
2016-06-04 20:08:10 -07:00
Senthil Kumaran 7749320142 Issue27203 - Fix doctests Doc/faq/programming.rst.
Patch contributed by Jelle Zijlstra.
2016-06-04 20:07:34 -07:00
Berker Peksag 32072714fd Merge from 3.5 2016-06-01 13:55:00 -07:00
Berker Peksag 5b6a14d1cb Fix link in programming FAQ.
The example actually uses the sort method of list object.
2016-06-01 13:54:33 -07:00
Benjamin Peterson f50cc9ad66 merge 3.5 2016-05-26 22:56:51 -07:00
Benjamin Peterson 047ada4ef3 remove cruft from Schwarzian transform section 2016-05-26 22:55:49 -07:00
Benjamin Peterson 3f69f02792 merge 3.5 2016-05-26 22:51:44 -07:00
Benjamin Peterson 6d3ad2f64d "Numeric Python" -> "NumPy" 2016-05-26 22:51:32 -07:00
Serhiy Storchaka c499f30286 Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Serhiy Storchaka 1acbf853c8 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:58 +03:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Georg Brandl 3902d62c4e merge with 3.5 2016-02-26 19:37:52 +01:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Martin Panter bc1ee460dc Issue #25179: Documentation for formatted string literals aka f-strings
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
Martin Panter d5db14794b Issue #25179: Preparatory cleanup of existing docs on string formatting
* Various sections were pointing to the section on the string.Formatter
  class, when the section on the common format string syntax is probably more
  appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Senthil Kumaran d03d1d45f5 Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki. 2016-01-01 23:25:58 -08:00
Martin Panter 7462b64911 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
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Martin Panter 7f02d6d0d9 Issue #23406: Clarify documentation on multiplying a sequence
Patch from Matheus Vieira Portela.
2015-09-07 02:08:55 +00:00
Robert Collins bd4dd54737 Issue #23589: Remove duplicate sentence from the FAQ. Patch by Yongzhi Pan. 2015-07-30 06:14:32 +12:00
Georg Brandl b7354a65ce Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl 77fe77d4af Fixing broken links in doc, part 1: faq/ 2014-10-29 09:24:54 +01:00
Georg Brandl 5e722f698e Remove now-dead link to IDLE debugger doc and add PyCharm to the commercial IDEs. 2014-10-29 08:55:14 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl a94ad1e508 Closes #10031: overhaul the "imports" section of the programming FAQ.
Remove the advice to never use relative imports; it is a leftover from 2.x implicit relative imports.
Remove the advice to locally import modules in __init__, it is a strange practice.
Remove the advice to use "from ... import *" with some modules.
2014-10-06 16:02:09 +02:00
R David Murray 12dc0d96e0 #20135: FAQ entry for list mutation. (See also 6375bf34fff6.)
I accidentally committed this in 6375bf34fff6; this changeset addresses the
last review comments on the patch.

This is a perennial question and something someone opens a ticket for probably
every other month or so, so I'm surprised we didn't already have a FAQ entry
for it.

The original patch was written by M. Votz, refined first by Ezio Melotti and
further refined by me.
2014-09-29 10:17:28 -04:00
R David Murray 623ae29469 #10510: Fix bug in forward port of 2.7 distutils patch.
Pointed out by Arfrever.
2014-09-28 11:01:11 -04:00
Ezio Melotti e4aad5ab32 #18034: update FAQ to suggest importlib.import_module instead of __import__. Patch by Wouter van Heyst. 2014-08-04 19:34:29 +03:00
Ezio Melotti 898eb82696 #20135: move FAQ about mutable default arguments to the programming FAQs page. 2014-07-06 20:53:27 +03:00
Eric V. Smith 04d8a245f1 Fix faq example with division. 2014-04-14 07:52:53 -04:00
Eric V. Smith fc9a4d828e Fix text about int() with octal numbers. Closes #21212. 2014-04-14 07:41:52 -04:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
R David Murray 18701160cc Merge: #18036: update .pyc FAQ entry in light of PEP 3147. 2013-12-13 12:30:29 -05:00
R David Murray d913d9d54e #18036: update .pyc FAQ entry in light of PEP 3147.
Initial patch by Phil Connell.
2013-12-13 12:29:29 -05:00
Benjamin Peterson 5143ce5a01 merge 3.3 (#19805) 2013-11-26 23:05:37 -06:00
Benjamin Peterson b152e177ef recommend OrderedDict for this FAQ (closes #19805) 2013-11-26 23:05:25 -06:00
Georg Brandl 42840f017d merge with 3.3 2013-10-12 18:15:21 +02:00
Georg Brandl d8ede4fddd Closes #13203: add a FAQ section about seemingly duplicate id()s. 2013-10-12 18:14:25 +02:00
R David Murray 2f72aed1b4 Merge: Tweak programming faq examples so that it (mostly) passes doctest. 2013-06-19 16:59:22 -04:00
R David Murray fdf9503038 Tweak programming faq examples so that it (mostly) passes doctest.
The exception is the import related questions at the end, which
need to be rewritten anyway.
2013-06-19 16:58:26 -04:00
Brett Cannon 4f422e3414 Issue #17177: Update the programming FAQ to use importlib 2013-06-14 22:49:00 -04:00
Ezio Melotti c1f5839412 #18126: update NumPy links in the documentation. Patch by Yury V. Zaytsev. 2013-06-09 01:04:21 +03:00
R David Murray 95ae99205e #17973: fix technical inaccuracy in faq entry (it now passes doctest). 2013-05-21 11:44:41 -04:00
R David Murray bcf06d364d #17973: Add FAQ entry for ([],)[0] += [1] both extending and raising.
This has come up often enough now on the tracker that it deserves a FAQ entry.
2013-05-20 10:32:46 -04: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 cad8b0ff8e #13094: add Programming FAQ entry about the behavior of closures. 2013-01-05 00:50:46 +02: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
Chris Jerdonek c2a7fd60e1 Improve argument/parameter documentation (issue #15990).
This commit adds "parameter" to the glossary, improves and consolidates the
"argument" glossary entry, and adds a question to the FAQ on the difference
between arguments and parameters.
2012-11-28 02:29:33 -08:00
Georg Brandl 300a691026 Closes #14305: fix typo. 2012-03-14 22:40:08 +01:00
Antoine Pitrou 432259feea Issue #13528: rework the performance question in the programming FAQ 2011-12-09 23:10:31 +01:00
Antoine Pitrou f35204055e Remove outdate FAQ content 2011-12-03 22:19:55 +01:00
Antoine Pitrou c5b266efb5 Streamline FAQ entry about the ternary operator, and suggest using io.StringIO for a mutable unicode container. 2011-12-03 22:11:11 +01:00
Antoine Pitrou 9cb41dfbaa Remove references to psyco, which is mostly unmaintained and doesn't work with Python 3. 2011-12-03 21:21:36 +01:00
Antoine Pitrou fd9ebd4a36 Clarify concatenation behaviour of immutable strings, and remove explicit
mention of the CPython optimization hack.
2011-11-25 16:33:53 +01:00
Éric Araujo 7af8ebb6ce Adapt/remove mentions of functions gone in 3.x 2011-09-01 03:20:13 +02:00
Georg Brandl e1eef41a18 Close #12838: fix range() call. 2011-08-25 11:52:26 +02:00
Antoine Pitrou 09264b66f2 Mention Cython and remove obsolete alternatives 2011-02-05 10:57:17 +00:00
Georg Brandl 60203b41b0 Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00
Brian Curtin 5a7a52fbb0 #9582 - add a missing "are" and reflow the line. 2010-09-23 13:45:21 +00:00
Georg Brandl 6faee4e2ce #9911: doc copyedits. 2010-09-21 14:48:28 +00:00
Georg Brandl c4a55fccab Recorded merge of revisions 78024 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78024 | georg.brandl | 2010-02-06 19:44:44 +0100 (Sa, 06 Feb 2010) | 1 line

  #5341: fix "builtin" where used as an adjective ("built-in" is correct).
........
2010-02-06 18:46:57 +00:00
Georg Brandl 11b636291a #7495: more review fixes. 2009-12-20 14:21:27 +00:00
Georg Brandl 62eaaf62ff #7495: Review of Programming FAQ by Florent Xicluna. 2009-12-19 17:51:41 +00:00
R. David Murray 18163c3f14 Fix print function conversion missed in merge of faq/programming update. 2009-11-14 22:27:22 +00:00
R. David Murray c04a694614 Merged revisions 76190 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r76190 | r.david.murray | 2009-11-10 13:58:02 -0500 (Tue, 10 Nov 2009) | 3 lines

  Update the FAQ entry that explains that assignments in the local scope
  shadow variables in the outer scope (issue 7290).
........
2009-11-14 22:21:32 +00:00
Georg Brandl 495f7b5adb Merged revisions 75365,75394,75402-75403,75418,75459,75484,75592-75596,75600,75602-75607,75610-75613,75616-75617,75623,75627,75640,75647,75696,75795 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r75365 | georg.brandl | 2009-10-11 22:16:16 +0200 (So, 11 Okt 2009) | 1 line

  Fix broken links found by "make linkcheck".  scipy.org seems to be done right now, so I could not verify links going there.
........
  r75394 | georg.brandl | 2009-10-13 20:10:59 +0200 (Di, 13 Okt 2009) | 1 line

  Fix markup.
........
  r75402 | georg.brandl | 2009-10-14 17:51:48 +0200 (Mi, 14 Okt 2009) | 1 line

  #7125: fix typo.
........
  r75403 | georg.brandl | 2009-10-14 17:57:46 +0200 (Mi, 14 Okt 2009) | 1 line

  #7126: os.environ changes *do* take effect in subprocesses started with os.system().
........
  r75418 | georg.brandl | 2009-10-14 20:48:32 +0200 (Mi, 14 Okt 2009) | 1 line

  #7116: str.join() takes an iterable.
........
  r75459 | georg.brandl | 2009-10-17 10:57:43 +0200 (Sa, 17 Okt 2009) | 1 line

  Fix refleaks in _ctypes PyCSimpleType_New, which fixes the refleak seen in test___all__.
........
  r75484 | georg.brandl | 2009-10-18 09:58:12 +0200 (So, 18 Okt 2009) | 1 line

  Fix missing word.
........
  r75592 | georg.brandl | 2009-10-22 09:05:48 +0200 (Do, 22 Okt 2009) | 1 line

  Fix punctuation.
........
  r75593 | georg.brandl | 2009-10-22 09:06:49 +0200 (Do, 22 Okt 2009) | 1 line

  Revert unintended change.
........
  r75594 | georg.brandl | 2009-10-22 09:56:02 +0200 (Do, 22 Okt 2009) | 1 line

  Fix markup.
........
  r75595 | georg.brandl | 2009-10-22 09:56:56 +0200 (Do, 22 Okt 2009) | 1 line

  Fix duplicate target.
........
  r75596 | georg.brandl | 2009-10-22 10:05:04 +0200 (Do, 22 Okt 2009) | 1 line

  Add a new directive marking up implementation details and start using it.
........
  r75600 | georg.brandl | 2009-10-22 13:01:46 +0200 (Do, 22 Okt 2009) | 1 line

  Make it more robust.
........
  r75602 | georg.brandl | 2009-10-22 13:28:06 +0200 (Do, 22 Okt 2009) | 1 line

  Document new directive.
........
  r75603 | georg.brandl | 2009-10-22 13:28:23 +0200 (Do, 22 Okt 2009) | 1 line

  Allow short form with text as argument.
........
  r75604 | georg.brandl | 2009-10-22 13:36:50 +0200 (Do, 22 Okt 2009) | 1 line

  Fix stylesheet for multi-paragraph impl-details.
........
  r75605 | georg.brandl | 2009-10-22 13:48:10 +0200 (Do, 22 Okt 2009) | 1 line

  Use "impl-detail" directive where applicable.
........
  r75606 | georg.brandl | 2009-10-22 17:00:06 +0200 (Do, 22 Okt 2009) | 1 line

  #6324: membership test tries iteration via __iter__.
........
  r75607 | georg.brandl | 2009-10-22 17:04:09 +0200 (Do, 22 Okt 2009) | 1 line

  #7088: document new functions in signal as Unix-only.
........
  r75610 | georg.brandl | 2009-10-22 17:27:24 +0200 (Do, 22 Okt 2009) | 1 line

  Reorder __slots__ fine print and add a clarification.
........
  r75611 | georg.brandl | 2009-10-22 17:42:32 +0200 (Do, 22 Okt 2009) | 1 line

  #7035: improve docs of the various <method>_errors() functions, and give them docstrings.
........
  r75612 | georg.brandl | 2009-10-22 17:52:15 +0200 (Do, 22 Okt 2009) | 1 line

  #7156: document curses as Unix-only.
........
  r75613 | georg.brandl | 2009-10-22 17:54:35 +0200 (Do, 22 Okt 2009) | 1 line

  #6977: getopt does not support optional option arguments.
........
  r75616 | georg.brandl | 2009-10-22 18:17:05 +0200 (Do, 22 Okt 2009) | 1 line

  Add proper references.
........
  r75617 | georg.brandl | 2009-10-22 18:20:55 +0200 (Do, 22 Okt 2009) | 1 line

  Make printout margin important.
........
  r75623 | georg.brandl | 2009-10-23 10:14:44 +0200 (Fr, 23 Okt 2009) | 1 line

  #7188: fix optionxform() docs.
........
  r75627 | fred.drake | 2009-10-23 15:04:51 +0200 (Fr, 23 Okt 2009) | 2 lines

  add further note about what's passed to optionxform
........
  r75640 | neil.schemenauer | 2009-10-23 21:58:17 +0200 (Fr, 23 Okt 2009) | 2 lines

  Improve some docstrings in the 'warnings' module.
........
  r75647 | georg.brandl | 2009-10-24 12:04:19 +0200 (Sa, 24 Okt 2009) | 1 line

  Fix markup.
........
  r75696 | georg.brandl | 2009-10-25 21:25:43 +0100 (So, 25 Okt 2009) | 1 line

  Fix a demo.
........
  r75795 | georg.brandl | 2009-10-27 16:10:22 +0100 (Di, 27 Okt 2009) | 1 line

  Fix a strange mis-edit.
........
2009-10-27 15:28:25 +00:00
Georg Brandl d404fa6e1c Update module names in references in the FAQ. 2009-10-13 16:55:12 +00:00
Georg Brandl d741315f37 Merged revisions 75363 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r75363 | georg.brandl | 2009-10-11 20:31:23 +0200 (So, 11 Okt 2009) | 1 line

  Add the Python FAQ lists to the documentation.  Copied from sandbox/faq.  Many thanks to AMK for the preparation work.
........
2009-10-11 21:25:26 +00:00