search

marrink-lab / vermouth-martinize

Describe and apply transformation on molecular structures and topologies
Apache License 2.0
95 stars 43 forks source link

Upgrade sphinx to latest, and fix doc issues #407

Closed pckroon closed 2 years ago

pckroon commented 2 years ago

Also add some napoleon config. Setting preprocess_types to True might (have been) a good idea, but will currently cause about 200 warnings, since that will break with e.g. list[str]. Instead we'd need to change it to e.g. list of str, and IMHO it results in less pretty html

pckroon commented 2 years ago

Pylint failed on bin/martinize2, which was set to 9.5. The score dropped because it started taking into account places where you should/could use f-strings rather than .format. So I dropped the requirement to a 9.0.

fgrunewald commented 2 years ago

yeah that makes sense. Personally I think the fstring should be treated equivalent to the format option in terms of linting. Because for long strings frstring becomes less easy to comprehend.