Update the help text for the Pylint descriptor

[primeos-work]

The msg-template setting only works in the pylintrc configuration file if it is under the [REPORTS] section header 0. Otherwise the setting gets ignored:

$ cat ./pylintrc
msg-template={path}:{module}:{line}: [{msg_id}({symbol}), {obj}] {msg}
$ pylint --rcfile=./pylintrc test.py
************* Module pylintrc
pylintrc:1:0: F0011: error while parsing the configuration: File contains no section headers.
file: 'pylintrc', line: 1
'msg-template={path}:{module}:{line}: [{msg_id}({symbol}), {obj}] {msg}\n' (config-parse-error)
[...]

Using the --msg-template CLI option is more convenient for the usage inside Jenkins pipelines.

---

Related Jira issue: https://issues.jenkins.io/browse/JENKINS-71665

TODO: SUPPORTED-FORMATS.md must be regenerated.

Testing done

Submitter checklist

Beta Give feedback

1. Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
2. Ensure that the pull request title represents the desired changelog entry
3. Please describe what you did
4. Link to relevant issues in GitHub or Jira
5. Link to relevant pull requests, esp. upstream and downstream changes
6. Ensure you have provided tests - that demonstrates feature works or fixes the issue

[primeos-work]

@uhafner could you please regenerate SUPPORTED-FORMATS.md for me (since I don't have a development setup for this repo)?

[codecov]

Codecov Report

Merging #933 (666a98a) into master (ede6ea0) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##             master     #933   +/-   ##
=========================================
  Coverage     92.89%   92.89%           
  Complexity     2322     2322           
=========================================
  Files           341      341           
  Lines          6450     6450           
  Branches        669      669           
=========================================
  Hits           5992     5992           
  Misses          262      262           
  Partials        196      196           

Impacted Files	Coverage Δ
.../hm/hafner/analysis/registry/PyLintDescriptor.java	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[uhafner]

Can you please run mvn verify then the file will be re-generated. Then you can commit it as well.

[primeos-work]

Ok, I just did that and amended the commit. I also replaced ... with modules_or_packages (based on https://pylint.readthedocs.io/en/stable/user_guide/usage/run.html) as ... somehow resulted in a missing whitespace character before ...:

               :bulb: <p>Start Pylint using this custom message template (can also be configured via a pylintrc configuration file):<p><code>pylint --msg-template='{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})'... > pylint.log</code></p></p>

[uhafner]

Thanks!