Skip to content

docs: clarify multi-DR-params syntax and notebook gap#49

Merged
tsenoner merged 1 commit into
mainfrom
docs/multi-dr-params-followup
Apr 28, 2026
Merged

docs: clarify multi-DR-params syntax and notebook gap#49
tsenoner merged 1 commit into
mainfrom
docs/multi-dr-params-followup

Conversation

@tsenoner
Copy link
Copy Markdown
Owner

@tsenoner tsenoner commented Apr 27, 2026

Summary

Follow-up to PR #48 review feedback. Documents the four gaps identified after merge:

  • Explicit comma-vs-semicolon rule in the -m flag description
  • New "Overridable parameters" reference table with abbreviations
  • Disambiguation suffix behavior in the "Projection Naming" section
  • Notebook markdown cell pointing users at the CLI for parameter sweeps

Test plan

  • uv run ruff check src/ tests/ clean (nothing in code touched)
  • Notebook still valid JSON / nbformat
  • Cross-reference anchors verified
  • Manual rendering check on GitHub after push (anchor links resolve)

🤖 Generated with Claude Code

Follow-up to PR #48 review feedback.

- docs/cli.md: rewrite -m flag description to spell out the
  comma-vs-semicolon rule explicitly, add an "Overridable parameters"
  subsection listing the 11 valid override keys with their abbreviations
  and types, and extend "Projection Naming" with an example of the
  parameter-suffix disambiguation behavior.
- notebooks/ProtSpace_Preparation.ipynb: insert an informational markdown
  cell pointing power users at the CLI for parameter sweeps, since the
  toggle UI runs each method only once.

No code or behavior changes; release-bot will not bump the version.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tsenoner tsenoner merged commit 7c69274 into main Apr 28, 2026
4 checks passed
@tsenoner tsenoner deleted the docs/multi-dr-params-followup branch April 28, 2026 07:07
martinpycha pushed a commit to d0rr4/PP1 that referenced this pull request May 20, 2026
…lowup

docs: clarify multi-DR-params syntax and notebook gap
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant