Commit Graph

224 Commits

Author SHA1 Message Date
Miss Islington (bot) d9c61c2a26 bpo-31965: fix doc for multiprocessing.connection.Client and Listener (GH-4304) (#4321)
* fix doc for multiprocessing.connection.Client

The authenticate argument does not exist on either Client or Listener:
- https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.pyGH-L483 (master)
- https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.pyGH-L478 (3.6)
- https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.pyGH-L478 (3.5)
- https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.pyGH-L487 (3.4)
The documentation also claimed that these functions will call `current_process().auth_key`, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior.

Also made some small changes to vary sentence structure.
(cherry picked from commit 1e5d54cfa0)
2017-11-07 17:20:24 +01:00
Miss Islington (bot) 2702380870 bpo-31304: Update starmap_async documentation. (GH-4168) (GH-4177)
Update the kwarg in the documentation of `multiprocessing.pool.Pool.starmap_async`, from `error_back` to `error_callback` to match the source code.
(cherry picked from commit 11225753a8)
2017-10-30 11:47:39 -07:00
Mariatta e05119ad4e Fix trivial typo in multiprocessing documentation (GH-2930) (GH-2940)
(cherry picked from commit 6fcb69dad5)
2017-07-28 19:55:23 -07:00
Serhiy Storchaka 989db5c880 Issue #19795: Mark up None as literal text. 2016-10-19 16:37:13 +03:00
Serhiy Storchaka ecf41da83e Issue #19795: Mark up None as literal text. 2016-10-19 16:29:26 +03:00
Berker Peksag de10dbec77 Issue #10673: Merge from 3.5 2016-09-26 23:22:44 +03:00
Berker Peksag a24d2d8274 Issue #10673: Document that Process.exitcode can be used to determine timeout
Patch by Tom Clark.
2016-09-26 23:22:22 +03:00
Davin Potts 86a7668426 Fixes issue #6766: Updated multiprocessing Proxy Objects to support nesting 2016-09-07 18:48:01 -05:00
Berker Peksag 89f27e5888 Merge from 3.5 2016-06-12 12:26:08 +03:00
Berker Peksag 00eaa8a53b Use exc role for ValueError in multiprocessing.rst 2016-06-12 12:25:43 +03:00
Berker Peksag db287b5ca7 Issue #27221: Merge from 3.5 2016-06-12 12:19:39 +03:00
Berker Peksag 0b19e1e72c Issue #27221: Delete an outdated paragraph about pickle support of Process
Initial patch by Jelle Zijlstra.
2016-06-12 12:19:13 +03:00
Terry Jan Reedy 4da945f361 Merge Issue #22558. 2016-06-11 15:06:08 -04:00
Terry Jan Reedy 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
Martin Panter e501a93c18 Issue #27125: Merge typo fixes from 3.5
Also merge changes from Issue #27117; no actual code changes to 3.6.
2016-05-29 09:05:06 +00:00
Martin Panter 8d56c026a5 Issue #27125: Fix various errors like “will [be] inherited” 2016-05-29 04:13:35 +00:00
Serhiy Storchaka 4ecfa455ae Expand abbreviations FIFO and LIFO. 2016-05-16 09:31:54 +03: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
Victor Stinner a6d865c128 Issue #25654:
* multiprocessing: open file with closefd=False to avoid ResourceWarning
* _test_multiprocessing: open file with O_EXCL to detect bugs in tests (if a
  previous test forgot to remove TESTFN)
* test_sys_exit(): remove TESTFN after each loop iteration

Initial patch written by Serhiy Storchaka.
2016-03-25 09:29:50 +01:00
Berker Peksag 2e15d60b83 Issue #18620: Improve Pool examples in multiprocessing documentation
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:

    with Pool(processes=4) as pool:
        results = [pool.apply_async(func, ()) for i in range(4)]

Patch by Davin Potts.
2016-01-22 00:00:06 +02:00
Berker Peksag 7405c16533 Issue #18620: Improve Pool examples in multiprocessing documentation
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:

    with Pool(processes=4) as pool:
        results = [pool.apply_async(func, ()) for i in range(4)]

Patch by Davin Potts.
2016-01-21 23:59:49 +02:00
Senthil Kumaran 316fcc867b merge from 3.5
issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs.
2016-01-20 03:11:52 -08:00
Senthil Kumaran 6a0514ea20 issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs. 2016-01-20 03:10:13 -08:00
Berker Peksag d56e67e116 Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:45:47 +02:00
Berker Peksag 94541f464c Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:45:22 +02:00
Martin Panter e56a919100 Issue #25523: Merge a-to-an corrections from 3.5 2015-11-02 04:27:17 +00:00
Martin Panter 2eb819f7a8 Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5 2015-11-02 04:04:57 +00: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 430f657c67 Issue #25161: Merge full stops from 3.5 2015-10-10 10:45:00 +00:00
Martin Panter 84835ab1cb Issue #25161: Merge full stops from 3.4 into 3.5 2015-10-10 10:44:25 +00:00
Martin Panter d21e0b52f1 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:36:22 +00:00
Berker Peksag 33ffc055c8 Issue #23484: Document differences between synchronization primitives of
threading and multiprocessing modules.

In multiprocessing, the name of the first parameter of the acquire methods is
"block", but "blocking" in threading.

This commit also improves documentation of Lock and RLock.

Patch by Davin Potts.
2015-09-21 06:52:11 +03:00
Berker Peksag 64c8befaed Issue #23484: Document differences between synchronization primitives of
threading and multiprocessing modules.

In multiprocessing, the name of the first parameter of the acquire methods is
"block", but "blocking" in threading.

This commit also improves documentation of Lock and RLock.

Patch by Davin Potts.
2015-09-21 06:51:45 +03:00
Berker Peksag 407c497e83 Issue #23484: Document differences between synchronization primitives of
threading and multiprocessing modules.

In multiprocessing, the name of the first parameter of the acquire methods is
"block", but "blocking" in threading.

This commit also improves documentation of Lock and RLock.

Patch by Davin Potts.
2015-09-21 06:50:55 +03:00
Berker Peksag ad8dcb703e Issue #25169: os.getppid() is available on Windows since Python 3.2.
Patch by Bar Harel.
2015-09-21 06:13:36 +03:00
Berker Peksag b216896df4 Issue #25169: os.getppid() is available on Windows since Python 3.2.
Patch by Bar Harel.
2015-09-21 06:13:14 +03:00
Berker Peksag 44e4b11dd8 Issue #25169: os.getppid() is available on Windows since Python 3.2.
Patch by Bar Harel.
2015-09-21 06:12:50 +03:00
Serhiy Storchaka 233cdb3e9c Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:46:56 +03:00
Serhiy Storchaka 153627c111 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:46:20 +03:00
Serhiy Storchaka 0424eaf753 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
Charles-François Natali dc87e4b885 Issue #23530: Improve os.cpu_count() description.
Patch by Julian Taylor.
2015-07-13 21:01:39 +01:00
Berker Peksag 291d7b0284 Issue #23400: Raise same exception on both Python 2 and 3 if sem_open is not available.
Patch by Davin Potts.
2015-04-08 17:57:44 +03:00
Berker Peksag 7ecfc82edb Issue #23400: Raise same exception on both Python 2 and 3 if sem_open is not available.
Patch by Davin Potts.
2015-04-08 17:56:30 +03:00
Larry Hastings b2c2dc3643 Regenerated pydoc topics and minor doc fixes for 3.5.0a3. 2015-03-29 15:32:55 -07:00
Serhiy Storchaka a60c2fe480 Issue #23641: Cleaned out legacy dunder names from tests and docs.
Fixed 2 to 3 porting bug in pynche.ColorDB.
2015-03-12 21:56:08 +02:00
Serhiy Storchaka c2ccce791c Issue #23641: Cleaned out legacy dunder names from tests and docs.
Fixed 2 to 3 porting bug in pynche.ColorDB.
Added few tests for __truediv__, __floordiv__ and __matmul__.
2015-03-12 22:01:30 +02:00
Antoine Pitrou 2cae11e87e Issue #22952: improve multiprocessing doc introduction and defer notes until appropriate.
Patch by Davin Potts.
2015-01-11 15:06:39 +01:00
Antoine Pitrou 73dd030c8b Issue #22952: improve multiprocessing doc introduction and defer notes until appropriate.
Patch by Davin Potts.
2015-01-11 15:05:29 +01:00
Georg Brandl 93a56cdc37 Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:25:41 +01:00