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

Make the output reproducible #146

Merged
merged 1 commit into from Feb 28, 2018

Conversation

Projects
None yet
3 participants
@lamby
Contributor

lamby commented Dec 12, 2017

Whilst working on the Reproducible Builds effort [0], we noticed
that pydoctor generates output that is not reproducible.

By iterating over the filesystem (which returns values in a non-
determinstic order) we end up with different id="" attributes in
the HTML.

This affects other packages such as "subvertpy" amongst others.

[0] https://reproducible-builds.org/

Make the output reproducible.
Whilst working on the Reproducible Builds effort [0], we noticed
that pydoctor generates output that is not reproducible.

By iterating over the filesystem (which returns values in a non-
determinstic order) we end up with different id="" attributes in
the HTML.

This affects other packages such as "subvertpy" amongst others.

 [0] https://reproducible-builds.org/
@codecov

This comment has been minimized.

Show comment
Hide comment
@codecov

codecov bot Dec 12, 2017

Codecov Report

Merging #146 into master will increase coverage by 0.05%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #146      +/-   ##
==========================================
+ Coverage   62.31%   62.36%   +0.05%     
==========================================
  Files          21       20       -1     
  Lines        3375     3372       -3     
  Branches      707      707              
==========================================
  Hits         2103     2103              
+ Misses       1070     1067       -3     
  Partials      202      202
Impacted Files Coverage Δ
pydoctor/model.py 76.2% <100%> (ø) ⬆️
pydoctor/nevowhtml.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db15907...31f962c. Read the comment docs.

codecov bot commented Dec 12, 2017

Codecov Report

Merging #146 into master will increase coverage by 0.05%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #146      +/-   ##
==========================================
+ Coverage   62.31%   62.36%   +0.05%     
==========================================
  Files          21       20       -1     
  Lines        3375     3372       -3     
  Branches      707      707              
==========================================
  Hits         2103     2103              
+ Misses       1070     1067       -3     
  Partials      202      202
Impacted Files Coverage Δ
pydoctor/model.py 76.2% <100%> (ø) ⬆️
pydoctor/nevowhtml.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db15907...31f962c. Read the comment docs.

@glyph

This comment has been minimized.

Show comment
Hide comment
@glyph

glyph Feb 28, 2018

Member

Ideally this would come with a change, but it looks like a very straightforward change, and pydoctor doesn't have the greatest coverage to begin with :).

Thanks for this contribution!

Member

glyph commented Feb 28, 2018

Ideally this would come with a change, but it looks like a very straightforward change, and pydoctor doesn't have the greatest coverage to begin with :).

Thanks for this contribution!

@glyph glyph merged commit 9ca44b5 into twisted:master Feb 28, 2018

3 checks passed

codecov/patch 100% of diff hit (target 62.31%)
Details
codecov/project 62.36% (+0.05%) compared to db15907
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@lamby

This comment has been minimized.

Show comment
Hide comment
@lamby

lamby Feb 28, 2018

Contributor

@glyph

Ideally this would come with a change,

Hm? :)

Contributor

lamby commented Feb 28, 2018

@glyph

Ideally this would come with a change,

Hm? :)

@ldanielburr

This comment has been minimized.

Show comment
Hide comment
@ldanielburr

ldanielburr Feb 28, 2018

@lamby I think @glyph meant to say "Ideally this would come with a test,..."

ldanielburr commented Feb 28, 2018

@lamby I think @glyph meant to say "Ideally this would come with a test,..."

@lamby

This comment has been minimized.

Show comment
Hide comment
@lamby

lamby Feb 28, 2018

Contributor

Ah! Thanks :)

Contributor

lamby commented Feb 28, 2018

Ah! Thanks :)

@lamby lamby deleted the lamby:reproducible-output branch Feb 28, 2018

@glyph

This comment has been minimized.

Show comment
Hide comment
@glyph

glyph Mar 17, 2018

Member

Indeed that is what I meant.

Member

glyph commented Mar 17, 2018

Indeed that is what I meant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment