docs(pip): Refer to option constants instead of repeating their values

While this introduces an indirection for default value lookup, this avoids the two places to go out of sync, as happened before. Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Jul 17, 2024 · efed39f · efed39f
1 parent 22cd864
commit efed39f
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/plugins/package-managers/python/src/main/kotlin/Pip.kt b/plugins/package-managers/python/src/main/kotlin/Pip.kt
@@ -51,10 +51,10 @@ private const val OPTION_ANALYZE_SETUP_PY_INSECURELY_DEFAULT = true
  *
  * This package manager supports the following [options][PackageManagerConfiguration.options]:
  * - *analyzeSetupPyInsecurely*: If "true", `python-inspector` resolves dependencies from setup.py files by executing
- *   them. This is a potential security risk. Defaults to "true".
+ *   them. This is a potential security risk. Defaults to [OPTION_ANALYZE_SETUP_PY_INSECURELY_DEFAULT].
  * - *operatingSystem*: The name of the operating system to resolve dependencies for. One of "linux", "macos", or
- *   "windows". Defaults to "linux".
- * - *pythonVersion*: The Python version to resolve dependencies for. Defaults to "3.11".
+ *   "windows". Defaults to [OPTION_OPERATING_SYSTEM_DEFAULT].
+ * - *pythonVersion*: The Python version to resolve dependencies for. Defaults to [OPTION_PYTHON_VERSION_DEFAULT].
  */
 class Pip(
     name: String,