Skip to content
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

Merged
merged 3 commits into from
Aug 29, 2023

Conversation

CasperWA
Copy link
Collaborator

Fixes #169

Check whether a newline character (\n) exists in the given variable and parse it accordingly.

@CasperWA
Copy link
Collaborator Author

This branch has been used and tested in the OPTIMADE Gateway repository, see this workflow run.
It passed with flying colors.

Furthermore, I have tested the solution for parsing a single line locally with great success.

@codecov
Copy link

codecov bot commented Aug 29, 2023

Codecov Report

Merging #170 (2aa802b) into main (a056de7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #170   +/-   ##
=======================================
  Coverage   71.42%   71.42%           
=======================================
  Files           9        9           
  Lines         567      567           
=======================================
  Hits          405      405           
  Misses        162      162           

@CasperWA
Copy link
Collaborator Author

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".
@CasperWA
Copy link
Collaborator Author

CasperWA commented Aug 29, 2023

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".

image

Copy link
Contributor

@francescalb francescalb left a 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.

@CasperWA CasperWA merged commit 0e0df50 into main Aug 29, 2023
18 checks passed
@CasperWA CasperWA deleted the cwa/fix-169-pylint_options-single-line branch August 29, 2023 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pylint_options not working as intended
2 participants