Make docstrings-style compliant and add assert messaging

[zm711]

So I switched most of the docstrings over to the SI format (I'm sure I'm missed some though) and I tried to add assert messaging to help users.

[zm711]

The tests I broke were designed to prevent users from messing up. I'll take a look.

[codecov-commenter]

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (70d77be) 88.90% compared to head (ea24068) 88.92%.

Files	Patch %	Lines
src/probeinterface/probe.py	68.57%	11 Missing ⚠️
src/probeinterface/io.py	66.66%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #241      +/-   ##
==========================================
+ Coverage   88.90%   88.92%   +0.02%     
==========================================
  Files          10       10              
  Lines        1694     1698       +4     
==========================================
+ Hits         1506     1510       +4     
  Misses        188      188              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[zm711]

So one of the test failures was because I changed the type of error from Value to Type. I think it is a TypeError so I just changed that test.

The other set of failures were due to the fixture not specifying the contact_shape_params. Since the shape params are specific for the contact shape I think having an assert to prevent a user from doing this wrong is actually important, so I added the correct shape parameters for the fixture, but if you want me to revert that fixture and delete the assert confirming the correct mix of contact shape and contact shape params I could do that as well.

Coverage drop is just because I made some asserts multiple lines and not all asserts are being tested.

[zm711]

Okay I'm all done with everything -- I won't push anything unless I get feedback.

As a reminder (to check super carefully):
the assert I added in the generator (do you want me to delete and revert the test or do you think it is a good idea to prevent users from specifying the wrong shape params--also not sure if there is a specific spikeinterface test that could be affected by this change).

[alejoe91]

Thanks @zm711

I'll review between today and tomorrow!

[alejoe91]

Thanks @zm711

I requested a small change regarding the use of | and list[] for typing, which I believe needs from __future__ import annotations.

Could you add that when needed?

[zm711]

Just to be safe I added future to all files (like Heberto has said, it's easy to miss that since we only test on 3.10), so since ProbeInterface is a pretty small code base I think it safer to just have from future everywhere and then we can delete it later.

I also added .ds_store to the gitignore since I do some work on Macs and don't want to accidentally upload a bunch of folder organization files :)

coverage failed which caused the test to fail. Could you try just re-running the test :)