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.

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

Jump to bottom

DM-9458: Python 3 fixes #3

Merged
merged 4 commits into from Feb 27, 2017
Merged

DM-9458: Python 3 fixes #3

merged 4 commits into from Feb 27, 2017

Conversation

timj
Copy link
Member

@timj timj commented Feb 15, 2017

  • Minor fixes for Python 3
  • Repeatable output from makeDocs.

jonathansick
jonathansick approved these changes Feb 27, 2017
View reviewed changes
Copy link
Member

@jonathansick jonathansick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirm that it works on my computer under Python 3 (though I'm still trying to figure out how to run create_xlinkdocs.sh locally..) and the changes itself look good.

bin/makeDocs
with open(fullName) as fh:
try:
contents = "".join(fh.readlines())
except UnicodeDecodeError:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a story behind this that ought to be commented?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the story is that this open can open any files it finds in the doc directory and those include PNG files which really upset Unicode decoding... I guess I'll add a comment about that.

@timj
Fix some unicode errors
19314c2 
* Must catch a decoding error if reading a binary (such as a PNG).
* Must encode before hashing.
@timj
Sort items before stringification
2e7a858 
Without this it is impossible to compare the output from
makeDocs runs at different times, making it hard to spot real
differences.
@timj
Reword dependent versus depends
6b8cf54 
The documentation consists of that from all the packages that the
top product depends on.
@timj
Ignore xml directory
d6cef8d
@timj timj merged commit d6cef8d into master Feb 27, 2017
@ktlim ktlim deleted the tickets/DM-9458 branch August 25, 2018 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonathansick jonathansick jonathansick approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@timj @jonathansick