search

NeuromatchAcademy / course-content

NMA Computational Neuroscience course
https://compneuro.neuromatch.io
Creative Commons Attribution 4.0 International
2.65k stars 983 forks source link

codespell: config, workflow (fail if typos introduced) and some typos fixed #1083

Open yarikoptic opened 1 year ago

yarikoptic commented 1 year ago

The trickiest part was to ignore the embedded in notebooks images and videos - the most of the ways I saw so far ;-)

I mass ignored all detected short words, but may be many of them aren't even needed to be ignored, but some are variable names (case ignored).

spirosChv commented 1 year ago

@yarikoptic Unfortunately, your PR cannot pass our CI checks. Generally, we used a specific process to ensure that all notebooks are working (the full, student and instructor versions). For projects, we use a different process. Here, you have committed changes in instructor and student versions, which are handled by our CI automatically. Please refer to our contributing guidelines: https://github.com/NeuromatchAcademy/course-content/blob/main/.github/contributing.md

As you have corrected a lot of typos (which is great) maybe I can add you to the maintenance team to make those changes on our repo directly. PRs from forks have lead to several issues in the past. Send me an email if you want to contribute. Thank you very much for your effort and time!

yarikoptic commented 1 year ago

ok, I sent email to the email address at forth.gr discovered elsewhere (email in git history is not informative ;) ) .

FWIW: I also force-pushed to address one missed false positive. reviewed entire diff -- should be good now AFAIK,

iamzoltan commented 6 months ago

@yarikoptic are you still working on this?

yarikoptic commented 6 months ago

eh, since required more of a dance, I have went on with my other dues and missed an invitation to join from @spirosChv who kindly provided instructions via email on how to proceed (seems to not really requiring to join, should be able to do via PRs from forks)... hopefully I will find some time to get back to this, but no promises -- anyone is welcome to pick up the effort -- feel welcome to close this PR.

iamzoltan commented 1 month ago

@yarikoptic Can we revamp this? Maybe resolve conflicts and only edit the tutorials (the student and instructor versions get generated in the processing pipeline)

We can change the base to a PR that I will create in the repo so that the processing will run internally.

yarikoptic commented 1 month ago

FWIW, ignored one more name (Christina Savin), rebased/reran fixup. I didn't leave projects out yet - seems not that many/reasonable to review.

iamzoltan commented 3 weeks ago

great thanks! Are you going to review projects too?

yarikoptic commented 3 weeks ago

I think I did fix them up too ATM, have a look in the diff.

iamzoltan commented 3 weeks ago

will do, thanks!