From 823b267a93f7a80e6021d45fb27f2c9c56930257 Mon Sep 17 00:00:00 2001 From: Matthias Kramm Date: Wed, 25 Mar 2015 09:09:27 -0700 Subject: [PATCH] Change README.md example to use 'Undefined'. --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4e79f2a56..51cb0f313 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,21 @@ This data can e.g. be used for static analysis, type checking or type inference. Each Python module is represented by a `.py` "stub". This is a normal Python file (i.e., it can be interpreted by Python 3), except all the methods are empty. Python function annotations ([PEP 3107](https://www.python.org/dev/peps/pep-3107/)) -and Python type annotaitons ([PEP 484](http://www.python.org/dev/peps/pep-484/)) are used to describe the types the function has. +See ([PEP 484](http://www.python.org/dev/peps/pep-484/)) for the exact syntax +of the stub files. ## Example The below is an excerpt from the types for the `datetime` module. ``` -MAXYEAR = int() -MINYEAR = int() -__doc__ = str() -__file__ = str() -__name__ = str() -__package__ = None +MAXYEAR = Undefined(int) +MINYEAR = Undefined(int) +__doc__ = Undefined(str) +__file__ = Undefined(str) +__name__ = Undefined(str) +__package__ = Undefined(None) class date(object): def __init__(self, year: int, month: int, day: int): pass