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

Fix/3406/fix rawtextparser input handling 2 #3419

Merged
merged 8 commits into from
Nov 28, 2023

Conversation

Nereboss
Copy link
Contributor

@Nereboss Nereboss commented Nov 27, 2023

Fix RawTextParser incorrectly handling the max indentation level

Issue: #3406

Description

Fix RawTextParser internally setting a new max indentation level, independent from what the user put in.
This was done by refactoring relevant code and not using internal default values anymore.

Definition of Done

A PR is only ready for merge once all the following acceptance criteria are fulfilled:

  • Changes have been manually tested
  • All TODOs related to this PR have been closed
  • There are automated tests for newly written code and bug fixes
  • All bugs discovered while working on this PR have been submitted as issues (if not already an open issue)
  • Documentation (GH-pages, analysis/visualisation READMEs, parser READMEs, --help, etc.) has been updated (almost always necessary except for bug fixes)
  • CHANGELOG.md has been updated

@Nereboss
Copy link
Contributor Author

In the help (and github pages) the parameters -h and -v get put together into one -hv which can be confusing as we also have a flag -nc which has two letters. How should this be handled?

@Nereboss
Copy link
Contributor Author

The help for -metrics uses the internal name for the variable 'metricNames' as default value. This name was changed during refactoring. Can we manipulate the help to not use that internal value or how should this be handled?

@fritschldwg
Copy link
Contributor

The help for -metrics uses the internal name for the variable 'metricNames' as default value. This name was changed during refactoring. Can we manipulate the help to not use that internal value or how should this be handled?

Can be solved using a paramLabel: https://picocli.info/#_parameter_labels

@fritschldwg
Copy link
Contributor

In the help (and github pages) the parameters -h and -v get put together into one -hv which can be confusing as we also have a flag -nc which has two letters. How should this be handled?

This happens because picocli uses "-v" for the version flag, and it gets automatically combined with the "-h" flag. After checking the documentation, there doesn't seem to be a way to stop this, except for changing the verbose flag to something like "-ve" or a similar option.

@Nereboss Nereboss force-pushed the fix/3406/fix-rawtextparser-input-handling-2 branch from 887aafb to dfcb570 Compare November 28, 2023 10:51
@Nereboss Nereboss force-pushed the fix/3406/fix-rawtextparser-input-handling-2 branch from dfcb570 to affdc47 Compare November 28, 2023 10:59
Copy link

sonarcloud bot commented Nov 28, 2023

[CodeCharta Visualization] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link

sonarcloud bot commented Nov 28, 2023

[CodeCharta Analysis] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 2 Code Smells

95.9% 95.9% Coverage
0.0% 0.0% Duplication

@fritschldwg fritschldwg merged commit 717bb80 into main Nov 28, 2023
7 checks passed
@fritschldwg fritschldwg deleted the fix/3406/fix-rawtextparser-input-handling-2 branch November 28, 2023 11:23
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.

2 participants