Skip to content
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

fileio.py contains some documentation errors #97

Open
eclrbohnhoff opened this issue Nov 12, 2019 · 0 comments
Open

fileio.py contains some documentation errors #97

eclrbohnhoff opened this issue Nov 12, 2019 · 0 comments

Comments

@eclrbohnhoff
Copy link

eclrbohnhoff commented Nov 12, 2019

The doc in fileio.py says this:
https://github.com/gmggroup/omf/blob/bd28cd65c9eaae7e71988a4b8abcf2f918c792c6/omf/fileio.py#L33

But actually uses this:
https://github.com/gmggroup/omf/blob/bd28cd65c9eaae7e71988a4b8abcf2f918c792c6/omf/fileio.py#L73

The doc says the header uses a UUID in little-endian:
https://github.com/gmggroup/omf/blob/bd28cd65c9eaae7e71988a4b8abcf2f918c792c6/omf/fileio.py#L35

But actually uses big-endian:
https://github.com/gmggroup/omf/blob/bd28cd65c9eaae7e71988a4b8abcf2f918c792c6/omf/fileio.py#L77

As described by python doc:
https://docs.python.org/3/library/uuid.html

UUID.bytes
The UUID as a 16-byte string (containing the six integer fields in big-endian byte order).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant