validate icon indicating copy to clipboard operation
validate copied to clipboard

Configuration file documenation does not match actual config file options

Open jstone-psi opened this issue 1 year ago • 0 comments

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
    • validate.catalog - Does not work, see https://github.com/NASA-PDS/validate/issues/150
  • 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

jstone-psi avatar Oct 04 '24 17:10 jstone-psi