Expand param description

[Opt-Mucca]

This comes via a request from @svigerske in #2678

@svigerske I don't think there's any desire to expand this parameter to something like "don't separate for nodes after a certain depth". Do you think values outside default and 0 are commonly used?

@galabovaa Does this automatically get updated in the documentation?

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.25%. Comparing base (71d0157) to head (9613a02).
⚠️ Report is 46 commits behind head on latest.

Additional details and impacted files

@@           Coverage Diff           @@
##           latest    #2819   +/-   ##
=======================================
  Coverage   80.25%   80.25%           
=======================================
  Files         348      348           
  Lines       86159    86159           
=======================================
  Hits        69151    69151           
  Misses      17008    17008           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[svigerske]

If one wants to limit separation, but not only to the root node, then something like a depth limit seems suitable. But no, I don't think this is commonly done.

[jajhall]

@galabovaa Does this automatically get updated in the documentation?

Not currently, as some options in docs/src/options/definitions.md have an @id tag so they can be referenced elsewhere in the documentation. Simplest if they all have such a tag, so definitions.md can be entirely auto-generated