search

edsu / pymarc

process MARC records from Python
http://python.org/pypi/pymarc
Other
251 stars 99 forks source link

Linting #150

Closed herrboyer closed 4 years ago

herrboyer commented 4 years ago

Fixes #148

edsu commented 4 years ago

@herrboyer let me know when you think this is ready and I will take a look.

herrboyer commented 4 years ago

Hi @edsu sorry for the noise on this PR, I had some problems with Travis... I think I'm done with the linting, let me know what you think.

About the last item on the checklist, would adding a few words in a CONTRIBUTING.md file be OK with you ?

herrboyer commented 4 years ago

In fact I think that the information on the linter have more their place in the documentation ... The contribution guide is a little too vast for me to approach it on this PR ...

Somehow I went overboard and did a reorganization of the documentation in the last commit (same content, but in a single page and a I think better ToC). Let me know @edsu if I should rollback.

herrboyer commented 4 years ago

Well, now I think I'm done @edsu, looking forward to reading your feedback !

edsu commented 4 years ago

@herrboyer this is an incredible amount of cleanup, thank you for doing it! Adding a CONTRIBUTING.md file would be useful yes if you still have the energy for that. Were you thinking that's where details could go about how to lint? I hadn't seen black before, so I'll be interested to see how it works in practice for my other projects.

edsu commented 4 years ago

Oh, I see the new Contributing section in the docs. Did you think that would work better as a separate file in the root? I worry that it might get a bit lost in the docs.

And thanks to @wooble I see that black is smart enough to fix the problems it finds :-) So maybe it wasn't so much work for you to do, but I still appreciate the time you spent adding it.

herrboyer commented 4 years ago

And thanks to @Wooble I see that black is smart enough to fix the problems it finds :-) So maybe it wasn't so much work for you to do, but I still appreciate the time you spent adding it.

Yes black was able to apply all the formatting rules, it's a wonderful tool. Most of my time was spent on making flake8 happy (doctrings, unused imports/variables, etc.)

herrboyer commented 4 years ago

Oh, I see the new Contributing section in the docs. Did you think that would work better as a separate file in the root? I worry that it might get a bit lost in the docs.

Well I hesitated a bit about this, but you're right, it's a bit lost after the api docs... Moved it to the standard CONTRIBUTING.md file here https://github.com/edsu/pymarc/pull/150/commits/6800d5dee1740d5085cc38269aab83b77fbfe020

edsu commented 4 years ago

🙌