Tweak description of experimental script prerequisites

[mernst]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates two documentation files with structural and formatting changes. scripts/experiment-scripts/README.md changes the "Running Scripts" section from a level-2 to level-3 heading and expands example usage by adding shell script invocation blocks such as ./mutation-fig7.sh and ./defects4j-table4.sh with accompanying explanatory notes. scripts/prerequisites.md reformats package names from emphasis to inline code formatting, restructures the environment setup section heading to focus on "Adding Defects4J to PATH," and revises PATH guidance paragraphs with more explicit language and adjusted formatting while maintaining overall meaning.

Possibly related PRs

• Defects4j scripts #70: Edits the same documentation files (scripts/experiment-scripts/README.md and scripts/prerequisites.md) with overlapping changes to section headings and script usage examples.

Pre-merge checks and finishing touches

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f04891e and 95a06f3.

📒 Files selected for processing (2)

• scripts/experiment-scripts/README.md (1 hunks)
• scripts/prerequisites.md (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-10-13T23:36:38.701Z

Learnt from: varuniy
Repo: randoop/grt-testing PR: 64
File: scripts/defect-randoop.sh:236-243
Timestamp: 2025-10-13T23:36:38.701Z
Learning: In Defects4J, the command `defects4j export -p cp.compile` automatically compiles the project before returning the classpath, so an explicit `defects4j compile` step is not needed when using `export -p cp.compile`.

Applied to files:

• scripts/prerequisites.md

📚 Learning: 2025-10-14T03:30:11.765Z

Learnt from: varuniy
Repo: randoop/grt-testing PR: 64
File: scripts/defects4j-randoop.sh:332-335
Timestamp: 2025-10-14T03:30:11.765Z
Learning: In defects4j-randoop.sh, the script intentionally removes RegressionTest.java and ErrorTest.java (the driver/suite files) after test generation because run_bug_detection.pl does not expect these files. The numbered test files (RegressionTest0.java, RegressionTest1.java, ErrorTest0.java, etc.) remain in TEST_DIR and are packaged for defect detection.

Applied to files:

• scripts/prerequisites.md

🔇 Additional comments (4)

scripts/prerequisites.md (2)

28-38: Clear formatting for package manager documentation.

The use of inline code formatting (pip, uv) combined with bold headings makes the installation instructions more scannable and easier to follow.

---

49-59: Good restructuring to clarify PATH setup intent.

Renaming the section from a generic heading to "Adding Defects4J to PATH" better communicates the specific purpose. The concrete example path (currentdirectory/build/defects4j) and explicit language about "PATH2DEFECTS4J" being the directory containing Defects4J improve clarity for users.

scripts/experiment-scripts/README.md (2)

17-30: Good hierarchy and concrete examples improve usability.

The heading level change from level-2 to level-3 correctly reflects the section hierarchy under "## Setup". The added shell script examples (./mutation-fig7.sh, ./defects4j-table4.sh) provide concrete, actionable guidance that makes the documentation much more user-friendly than abstract prose.

---

32-36: Helpful guidance on script documentation.

Explicitly documenting what users will find at the top of each script file (what it generates, input parameters, output files) sets clear expectations and helps users navigate the codebase more efficiently.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

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.}