chore(doc):SP-4029 update scanoss_settings_schema.rst with scan tunni…

[agustingroh]

…ng parameters

Summary by CodeRabbit

• Documentation
  • Added documentation for scan tuning parameters with detailed descriptions, default values, and configuration options for snippet matching optimization.
  • Included practical example configurations and extended the complete example JSON demonstrating file_snippet block usage in scanoss.json settings.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation updates added a new "Scan Tuning Parameters" section describing snippet matching configuration options for the scanoss.json settings file, including parameter definitions, types, defaults, and usage examples.

Changes

Cohort / File(s)	Summary
Documentation - Scan Tuning Parameters docs/source/scanoss_settings_schema.rst	Added new "Scan Tuning Parameters" section with table describing min_snippet_hits, min_snippet_lines, ranking_enabled, ranking_threshold, and honour_file_exts parameters. Included file_snippet block configuration example and extended the complete example JSON to demonstrate the new settings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A documentation hop, so neat and bright,
With tuning parameters now in sight!
The snippet matching guide takes flight,
Configuration examples shining light,
SCANOSS settings documented right! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly indicates the PR updates documentation with scan tuning parameters, which aligns with the main changeset that adds a 'Scan Tuning Parameters' section to the scanoss_settings_schema.rst file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/SP-4029-update-scanoss-settings-schema-doc

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

SCANOSS SCAN Completed 🚀

• Detected components: 3
• Undeclared components: 0
• Declared components: 3
• Detected files: 106
• Detected files undeclared: 0
• Detected files declared: 106
• Licenses detected: 2
• Licenses detected with copyleft: 1
• Policies: ✅ 1 pass (1 total)

View more details on SCANOSS Action Summary

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/source/scanoss_settings_schema.rst (1)

29-31: ⚠️ Potential issue | 🟡 Minor

Update the “settings” description to include scan tuning.

The text says settings only controls skip, but the new file_snippet section adds tuning options. Please revise this paragraph to mention both skip and file_snippet.