pymapdl

pymapdl copied to clipboard

Is your feature request related to a problem? Please describe. Codacy currently reports bad code style on almost all PRs

Describe the solution you'd like Configure inspection profile for tools run by codacy to remove all the false positives. For example D213 which complains that all multi-line docstrings have no line break before the summary.

Describe alternatives you've considered Disable the inspections wholesale. This seems like a baby-bathwater situation, the inspection can be useful to detect things like malformatted docstrings.

Additional context PEP-257 Tool is reporting a smidgen over 2000 issues, of which the vast majority are decisions we have taken deliberately, or not actual issues (it has two inspections which are mutually exclusive, D212 and D213 for example: https://github.com/PyCQA/prospector/issues/370)

I'm not sure how to approach this. @jorgepiloto can you have a look at this?

I think we can configure prospector, for example, with a yaml file - see https://prospector.landscape.io/en/master/profiles.html#profiles-configuration

It looks like codacy should respect the config options for each inspector, so we just need to decide what we want to use and fine tune the inspection profiles

Just saw this issue, sorry for the delay. Working on this... ⚙️