MDAnalysis / MDAnalysisData

Access to data for workshops and extended tests of MDAnalysis.
https://www.mdanalysis.org/MDAnalysisData
BSD 3-Clause "New" or "Revised" License
14 stars 5 forks source link

doc updates: contributing datasets and generate authors list from AUTHORS #49

Closed orbeckst closed 3 years ago

orbeckst commented 3 years ago
codecov[bot] commented 3 years ago

Codecov Report

Merging #49 (9c08ccd) into master (56f9ae0) will increase coverage by 0.82%. The diff coverage is 100.00%.

:exclamation: Current head 9c08ccd differs from pull request most recent head ea62356. Consider uploading reports for the commit ea62356 to get more accurate results Impacted file tree graph

@@            Coverage Diff             @@
##           master      #49      +/-   ##
==========================================
+ Coverage   55.70%   56.53%   +0.82%     
==========================================
  Files          12       12              
  Lines         368      375       +7     
  Branches       47       47              
==========================================
+ Hits          205      212       +7     
  Misses        160      160              
  Partials        3        3              
Impacted Files Coverage Δ
MDAnalysisData/__init__.py 100.00% <100.00%> (ø)

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 56f9ae0...ea62356. Read the comment docs.

pep8speaks commented 3 years ago

Hello @orbeckst! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 27:1: E402 module level import not at top of file

Comment last updated at 2021-07-20 01:44:10 UTC
IAlibay commented 3 years ago

@orbeckst I've not reviewed yet since you seemed to be actively doing commits on this, let me know when you want me to have a look?

orbeckst commented 3 years ago

I'm done, I was just bored while making breakfast and fixed a typo.

Originally I only wanted to add the contributions page but then added the AUTHORS processing, and then figured that testing the authors processing involved mocking imports, and then it spiralled out of control ;-). Sorry for such a heterogenous PR.

Anyway, if you could have a quick look then that would be much appreciated.

orbeckst commented 3 years ago

I rewrote the history so that the three different things (doc update, setup.py fixes, and author list) are separate commits; should be mergeable as is. Thank you @IAlibay for the simpler solution with monkeypatch.

orbeckst commented 3 years ago

Can you please block the merge again? I realize that I took dynamic_authors() from the MDA setup.py which is also under GPL. This needs to be either rewritten or (according to git blame setup.py) I need @jbarnoud @lilyminium @tylerjereddy (who all edited the code) to re-license dynamic_authors under BSD-3.

orbeckst commented 3 years ago

I added the re-licensing note.

orbeckst commented 3 years ago

Yep, thank you!