docs: clarify tutorials usage

DeepRank / deeprank2

An open-source deep learning framework for data mining of protein-protein interfaces or single-residue variants.

https://deeprank2.readthedocs.io/en/latest/?badge=latest

Apache License 2.0

32 stars 12 forks source link

docs: clarify tutorials usage #620

Closed gcroci2 closed 2 months ago

gcroci2 commented 2 months ago

I added a disclaimer in the tutorials' readme to make user that users know that they are not supposed to run the notebooks' code into python interactive shell.

coveralls commented 2 months ago

coverage: 83.933%. remained the same when pulling 58311f936468c1df7c7bc11470bd94c15960008e on 609_inspect_source_code_clarify_gcroci2 into 04615569d251f37918e16cb459b0581ef1d2c8fa on main.

gcroci2 commented 2 months ago

Good addition. This clarifies that users should use the system we provide. I do think we can be less explicit about what goes wrong if they don't (as per my suggestion below).

I accepted your suggestion and I removed the section's title (thinking about it the note is enough)

Also, should this PR point to dev instead of main? or is that not needed if it's just docs changes? It looks like it was branched off of dev, but now points to main.

Indeed, moved to dev :)