Skip to content

Add documentation examples for invalid-index-returned, invalid-bytes-returned, invalid-bool-returned, invalid-hash-returned #7576

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.

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
merged 4 commits into from
Oct 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions doc/data/messages/i/invalid-bool-returned/bad.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
class BadBool:
"""__bool__ returns an int"""

def __bool__(self): # [invalid-bool-returned]
return 1
1 change: 0 additions & 1 deletion doc/data/messages/i/invalid-bool-returned/details.rst

This file was deleted.

6 changes: 5 additions & 1 deletion doc/data/messages/i/invalid-bool-returned/good.py
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# This is a placeholder for correct code for this message.
class GoodBool:
"""__bool__ returns `bool`"""

def __bool__(self):
return True
5 changes: 5 additions & 0 deletions doc/data/messages/i/invalid-bytes-returned/bad.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
class BadBytes:
"""__bytes__ returns <type 'str'>"""

def __bytes__(self): # [invalid-bytes-returned]
return "123"
1 change: 0 additions & 1 deletion doc/data/messages/i/invalid-bytes-returned/details.rst

This file was deleted.

6 changes: 5 additions & 1 deletion doc/data/messages/i/invalid-bytes-returned/good.py
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# This is a placeholder for correct code for this message.
class GoodBytes:
"""__bytes__ returns <type 'bytes'>"""

def __bytes__(self):
return b"some bytes"
5 changes: 5 additions & 0 deletions doc/data/messages/i/invalid-hash-returned/bad.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
class BadHash:
"""__hash__ returns dict"""

def __hash__(self): # [invalid-hash-returned]
return {}
1 change: 0 additions & 1 deletion doc/data/messages/i/invalid-hash-returned/details.rst

This file was deleted.

6 changes: 5 additions & 1 deletion doc/data/messages/i/invalid-hash-returned/good.py
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# This is a placeholder for correct code for this message.
class GoodHash:
"""__hash__ returns `int`"""

def __hash__(self):
return 19
5 changes: 5 additions & 0 deletions doc/data/messages/i/invalid-index-returned/bad.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
class BadIndex:
"""__index__ returns a dict"""

def __index__(self): # [invalid-index-returned]
return {"19": "19"}
1 change: 0 additions & 1 deletion doc/data/messages/i/invalid-index-returned/details.rst

This file was deleted.

6 changes: 5 additions & 1 deletion doc/data/messages/i/invalid-index-returned/good.py
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# This is a placeholder for correct code for this message.
class GoodIndex:
"""__index__ returns <type 'int'>"""

def __index__(self):
return 19