-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Parse pylint_options
depending on newlines
#170
Conversation
This branch has been used and tested in the OPTIMADE Gateway repository, see this workflow run. Furthermore, I have tested the solution for parsing a single line locally with great success. |
Codecov Report
@@ Coverage Diff @@
## main #170 +/- ##
=======================================
Coverage 71.42% 71.42%
=======================================
Files 9 9
Lines 567 567
=======================================
Hits 405 405
Misses 162 162 |
This check should be included for all other input values that allows both single line and multi-line inputs. |
If it not accepted: Remove the mention of single line in the description of the input, leaving only "multi-line". And always parse as if it is a multi-line input. If it is accepted: Update the parsing to check for newline characters before actually parsing the input. Also add "(space-separated)" to describe a multi-valued single-line input.
A new section "General information" has been added in the documentation under the overview of the workflows. A section about single vs multi-line values have been added, including examples. This section has then been referenced throughout the documentation for specific input parameters that mention "single og multi-line values".
So I added the examples from the comment to the documentation. I did so under a new "General information" section in the overview page of the workflows (see below). I've also referenced this new section in the descriptions of the individual input parameters that mention "single or multi-line strings". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice with the updated documentaiton with examples.
Fixes #169
Check whether a newline character (
\n
) exists in the given variable and parse it accordingly.