Skip to content

CONTRIBUTING: Use PEP 526 syntax in example #1803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JelleZijlstra merged 5 commits into from
Jan 17, 2018
Merged

CONTRIBUTING: Use PEP 526 syntax in example #1803

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
070614c
CONTRIBUTING: Use PEP 526 syntax in example
srittau Jan 2, 2018
1fcb376
CONTRIBUTING: Add an example property, whitespace for grouping
srittau Jan 2, 2018
4ab082f
CONTRIBUTING: No default values from module-level constants
srittau Jan 2, 2018
d7933e0
CONTRIBUTING: Remove spurious blank lines in example
srittau Jan 2, 2018
0f3ed2e
Document that PEP 526 syntax is preferred
srittau Jan 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,17 +145,19 @@ that you know.
The below is an excerpt from the types for the `datetime` module.

```python
MAXYEAR = ... # type: int
MINYEAR = ... # type: int
MAXYEAR: int
MINYEAR: int

class date(object):
class date:
def __init__(self, year: int, month: int, day: int) -> None: ...
@classmethod
def fromtimestamp(cls, timestamp: float) -> date: ...
@classmethod
def today(cls) -> date: ...
@classmethod
def fromordinal(cls, ordinal: int) -> date: ...
@property
def year(self) -> int: ...
def replace(self, year: int = ..., month: int = ..., day: int = ...) -> date: ...
def ctime(self) -> str: ...
def weekday(self) -> int: ...
Expand All @@ -180,6 +182,8 @@ rule is that they should be as concise as possible. Specifically:
* use a single blank line between top-level class definitions, or none
if the classes are very small;
* do not use docstrings;
* use variable annotations instead of type comments, even for stubs
that target older versions of Python;
* for arguments with a type and a default, use spaces around the `=`.

Stub files should only contain information necessary for the type
Expand Down