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

Configuration file documenation does not match actual config file options #1019

Open
jstone-psi opened this issue Oct 4, 2024 · 0 comments

Comments

@jstone-psi
Copy link

jstone-psi commented Oct 4, 2024

Checked for duplicates

Yes - I've already checked

🐛 Describe the bug

When I used the "validate.noDataCheck" option in a configuration file, I received a deprecation warning. However, the option is not marked as deprecated in the documenation at (https://nasa-pds.github.io/validate/operate/index.html#using-a-configuration-file). Additionally, the replacement, "validate.skipContentValidation" does not appear in the list of configuration options.

I also had a few other options that I wanted to use that were not in the documentation, so I compared the documentation to the ConfigKey class and found the following discrepancies:

  • Not flagged as deprecated
    • validate.noDataCheck
  • Not documented
    • validate.checkInbetweenFields
    • validate.completeDescriptions
    • validate.disableContextMismatchWarnings
    • validate.everyN
    • validate.extension
    • validate.ignoreProductValidation
    • validate.pdfErrorDir
    • validate.skipContentValidation
    • validate.skipContextReferenceCheck
    • validate.targetManifest
  • Non-functional flags
  • Unrecognized flags
    • validate.targetListFile - possibly misnamed targetManifest
    • validate.regexp

🕵️ Expected behavior

I expected the documentation for the config file to match the actual options available for the current version of validate.

📜 To Reproduce

  1. check the documented options at https://nasa-pds.github.io/validate/operate/index.html#using-a-configuration-file
  2. compare to the ConfigKey class
  3. verify that every declared option in ConfigKey is used in ValidateLauncher

🖥 Environment Info

  • Version of this software validate 3.5.2

📚 Version of Software Used

validate 3.5.2

🩺 Test Data / Additional context

No response

🦄 Related requirements

🦄 #xyz

⚙️ Engineering Details

No response

🎉 Integration & Test

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ToDo
Development

No branches or pull requests

3 participants