search

ukan-computational-acoustics / ca-knowledgebase

Computational Acoustics Knowledgebase
https://knowledgebase.acoustics.ac.uk/
Creative Commons Attribution 4.0 International
16 stars 12 forks source link

Trying second pull request, after first didn't pass tests #118

Closed AndrewGibbs closed 2 years ago

AndrewGibbs commented 2 years ago

Run-flake-nb-checks makes 87 stylistic complaints, and then fails. Not sure how to interpret this!?

mscroggs commented 2 years ago

I'm merging this into a branch of the repo so I can fix the flake checks

mscroggs commented 2 years ago

@AndrewGibbs: As I guess we want this merged by tomorrow, I figured it was easier to fix it for you but for next time (see https://github.com/ca-knowledgebase/ca-knowledgebase.github.io/pull/119): the flake checks enforce common Python styling choices, in an aim to keep the code we have on the site consistent looking. The most common ones that fail are about how many spaces flake like before/after things.

To interpret the failures, you can click "Details" next to the failing test. Then you'll see lots of lines like: tutorials/bem/quick_BEM3.ipynb#In[2]:2:20: E231 missing whitespace after ',' This line (for example) is saying that in cell [2] of the file tutorials/bem/quick_BEM3.ipynb, line 2 character 20 there is a missing whitespace after a comma.

I've opened an issue to remind myself to put something about flake in the contributing guide: https://github.com/ca-knowledgebase/ca-knowledgebase.github.io/issues/120

AndrewGibbs commented 2 years ago

Ah I see! Thank you for fixing this @mscroggs. I am mostly self-taught in Python, so wasn't really aware of what the conventions are, but it certainly sounds like good practice to have all of our code following those.