Skip to content

Commit

Permalink
Standardize quote format in int.from_bytes/to_bytes docstring
Browse files Browse the repository at this point in the history
The motivation for this is that the unpaired backtick confuses Sphinx,
and inheriting from int (e.g. through enum.IntEnum) is pretty common.
See https://stackoverflow.com/q/77914856 for an example of the problem
this causes.
  • Loading branch information
geofft committed Feb 12, 2024
1 parent a82fbc1 commit d8d841f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Objects/clinic/longobject.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Objects/longobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -6026,7 +6026,7 @@ int.to_bytes
the most significant byte is at the beginning of the byte array. If
byteorder is 'little', the most significant byte is at the end of the
byte array. To request the native byte order of the host system, use
`sys.byteorder' as the byte order value. Default is to use 'big'.
'sys.byteorder' as the byte order value. Default is to use 'big'.
*
signed as is_signed: bool = False
Determines whether two's complement is used to represent the integer.
Expand Down Expand Up @@ -6090,7 +6090,7 @@ int.from_bytes
the most significant byte is at the beginning of the byte array. If
byteorder is 'little', the most significant byte is at the end of the
byte array. To request the native byte order of the host system, use
`sys.byteorder' as the byte order value. Default is to use 'big'.
'sys.byteorder' as the byte order value. Default is to use 'big'.
*
signed as is_signed: bool = False
Indicates whether two's complement is used to represent the integer.
Expand Down

0 comments on commit d8d841f

Please sign in to comment.