Commit Graph

86 Commits

Author SHA1 Message Date
Miss Islington (bot) b759a2c5b9
bpo-35581: Document @typing.type_check_only (GH-11312)
(cherry picked from commit 1e8295402b)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2019-04-12 15:47:57 -07:00
Miss Islington (bot) 68e0ed6a90
Update the seealso entries for namedtuple() (GH-12373)
* Replace external recipe link with a link to the dataclasses module.

* Highlight the class definition syntax for typing.NamedTuple
  and add an example for clarity.
(cherry picked from commit 9c68543f02)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-03-16 13:01:35 -07:00
Miss Islington (bot) f6097306ff Fix the versionadded info for typing.NoReturn (GH-11880)
The earliest version that `typing.NoReturn` appears in is [3.5.4rc1](https://docs.python.org/3/whatsnew/changelog.htmlGH-python-3-5-4-release-candidate-1)
(cherry picked from commit 903567e4f5)

Co-authored-by: Jack Wilsdon <jack.wilsdon@gmail.com>
2019-02-15 11:31:28 -08:00
Miss Islington (bot) 902196d867
bpo-35631: Improve typing docs wrt abstract/concrete collection types (GH-11396)
https://bugs.python.org/issue35631
(cherry picked from commit 31ec52a9af)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2019-01-04 06:20:19 -08:00
Miss Islington (bot) 6cb0486ce8
bpo-35341: Add generic version of OrderedDict to typing (GH-10850)
(cherry picked from commit 68b56d02ef)

Co-authored-by: Ismo Toijala <ismo.toijala@gmail.com>
2018-12-02 08:14:44 -08:00
Miss Islington (bot) c516dc6e57
bpo-35089: Don't mention typing.io and typing.re (GH-10173)
https://bugs.python.org/issue35089
(cherry picked from commit c8a8d6b347)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2018-10-28 09:16:36 -07:00
Miss Islington (bot) ec10b70ea6
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
(cherry picked from commit e483f02423)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-26 03:56:28 -07:00
Miss Islington (bot) 4ea64a25c2
Clarify that Type[SomeTypeVar] is legal (GH-9585)
Currently, the docs state that when doing `Type[X]`, X is only allowed to
be a class, a union of classes, and Any. This pull request amends
that sentence to clarify X may also be a typevar (or a union involving
classes, Any, and TypeVars).
(cherry picked from commit 130717fe58)

Co-authored-by: Michael Lee <michael.lee.0x2a@gmail.com>
2018-09-26 08:21:15 -07:00
Miss Islington (bot) e610c4f998
bpo-34336: Don't promote possibility to leave out typing.Optional (GH-8677)
(cherry picked from commit 336c945858)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-05 10:36:04 -07:00
Miss Islington (bot) 82d727fce6
Document typing.NoReturn (GH-7107)
(cherry picked from commit 6e413f4327)

Co-authored-by: Ivan Levkivskyi <levkivskyi@gmail.com>
2018-05-24 21:51:14 -07:00
Miss Islington (bot) 09ca5906b7 bpo-28556: Don't simplify unions at runtime (GH-6841) (GH-6979)
(cherry picked from commit f65e31fee3)

Co-authored-by: Ivan Levkivskyi <levkivskyi@gmail.com>
2018-05-18 16:27:14 -07:00
Miss Islington (bot) cc598ae264
Add AsyncContextManager to typing module documentation. (GH-6822)
(cherry picked from commit b7b493e2fb)

Co-authored-by: Travis DePrato <773453+travigd@users.noreply.github.com>
2018-05-14 18:10:47 -07:00
Sebastian Rittau c3e070f849 bpo-32284: Fix documentation of BinaryIO and TextIO (#4832) 2017-12-13 10:39:55 +02:00
Ivan Levkivskyi 0cd2e81bea bpo-29879: Update typing documentation. (GH-4573)
- Add "version added: 3.5.2" note where it was missing.
- Remove the mention that Reversible is new in 3.5.2
2017-11-26 14:23:02 -08:00
Éric Araujo 03b9537dc5 bpo-31567: more decorator markup fixes in docs (GH-3959) (#3966) 2017-10-12 12:28:55 -04:00
topper-123 039b25d8fd bpo-31564: Update typing documentation (GH-3696)
Mention that ``NewType`` can derive from another ``NewType``.
2017-09-23 19:37:48 -07:00
khyox 6580c19bbb bpo-30619: Clarify typing.Union documentation (GH-2326)
When a class and its subclass are present, the latter is skipped.
2017-06-22 06:14:57 -07:00
Mathias Rav 87c07fe9d9 bpo-29974: Improve typing.TYPE_CHECKING example (GH-982)
* Fix PEP 8 (SomeType instead of some_type)
* Add a function parameter annotation
* Explain, using wording from PEP 484 and PEP 526,
  why one annotation is in quotes and another is not.

Suggested by Ivan Levkevskyi.
2017-04-26 13:49:45 +03:00
Jelle Zijlstra 45d22c256b Improvements to typing documentation (#967)
Documents a few omitted classes and adds NamedTuple methods.
2017-04-08 19:09:14 +03:00
Mariatta 36da1c3589 bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#107) 2017-02-15 11:37:18 -08:00
Berker Peksag 5a001eea5b Issue #29198: Merge from 3.5 2017-02-04 09:34:48 +03:00
Berker Peksag 5702fb7b4d Issue #29198: Fix indentation and markup in typing.rst
Patch by Jelle Zijlstra.
2017-02-04 09:34:16 +03:00
Berker Peksag 14169b2a89 Issue #29198: Merge from 3.5 2017-02-04 09:18:42 +03:00
Berker Peksag 38962a6fe2 Issue #29198: Document typing.AsyncGenerator
Patch by Jelle Zijlstra.
2017-02-04 09:18:11 +03:00
Raymond Hettinger e53bd8e2d0 Issue 29310: Document typing.NamedTuple default argument syntax 2017-01-28 20:16:40 -08:00
Ned Deily 67c1cb2008 Issue #29316: Restore the provisional status of typing module and add
corresponding note to documentation. Patch by Ivan L.
2017-01-20 10:13:23 -05:00
Raymond Hettinger e12c313f5e merge 2017-01-16 22:43:43 -08:00
Raymond Hettinger 80490525e0 Issue #29011: Fix an important omission by adding Deque to the typing module. 2017-01-16 22:42:37 -08:00
Berker Peksag 4931122de8 Add missing square bracket in typing.get_type_hints() 2016-11-25 20:10:07 +03:00
Guido van Rossum a860286eab Issue #28773: Add typing.FrozenSet docs. (Manuel Krebber) 2016-11-24 11:56:00 -08:00
Berker Peksag 861b685941 Merge from 3.5 2016-11-25 20:10:30 +03:00
Guido van Rossum b3c5dc912d Issue #28773: Add typing.FrozenSet docs. (Manuel Krebber) (3.5->3.6) 2016-11-24 11:56:40 -08:00
Guido van Rossum 2d6c17936e Issue 28644: Document recent changes in typing.py (Ivan L) (3.5->3.6) 2016-11-11 15:57:09 -08:00
Guido van Rossum ae08687c3b Issue 28644: Document recent changes in typing.py (Ivan L) 2016-11-11 15:54:04 -08:00
Guido van Rossum 5ec24314cd Issue #28107: Update typing module documentation for NamedTuple (Ivan) 2016-10-25 09:53:11 -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
Guido van Rossum 7b2aa2e87c Adjust ClassVar example to use pre-PEP-526 syntax. (Issue #28388) 2016-10-08 20:12:54 -07:00
Guido van Rossum b258db9840 Issue #28388: update typing module documentation. (merge 3.5->3.6) 2016-10-08 20:09:56 -07:00
Guido van Rossum deed0c797c Issue #28388: update typing module documentation. 2016-10-08 20:06:56 -07:00
Guido van Rossum 56ff5f7298 Issue #26141: Update docs for typing.py. Ivan Levkivskyi. (Backport from the 3.6 version) 2016-09-10 19:03:22 -07:00
Guido van Rossum 446e168202 Issue #26141: Update docs for typing.py. Ivan Levkivskyi. 2016-09-10 18:54:14 -07:00
Guido van Rossum f7f8299967 Issue #28073: Improve wording around None. Michael Lee. (3.5->3.6) 2016-09-10 18:49:34 -07:00
Guido van Rossum 1816dfe65f Issue #28073: Improve wording around None. Michael Lee. 2016-09-10 18:49:14 -07:00
Guido van Rossum 922175922c Issue #28049: Add documentation for typing.Awaitable and friends.
By Michael Lee.
2016-09-09 11:46:34 -07:00
Guido van Rossum e848cd7605 Issue #27905: Docs for typing.Type[C], by Michael Lee. 2016-09-06 21:12:44 -07:00
Guido van Rossum 1de1a6a2dc Issue #27905: Docs for typing.Type[C], by Michael Lee. (Merge 3.5->3.6) 2016-09-06 21:13:15 -07:00
Vinay Sajip dd917f84e3 Closes #27904: Improved logging statements to defer formatting until needed. 2016-08-31 08:22:29 +01:00
Guido van Rossum b09b3f7ab9 Add docs for typing.AnyStr and typing.Text. By Michael Lee. (Merge 3.5->3.6) 2016-08-15 15:08:11 -07:00
Guido van Rossum aa9560c633 Add docs for typing.AnyStr and typing.Text. By Michael Lee. 2016-08-15 15:06:38 -07:00