fix broken table in documentation

[hyeoksu-lee]

User description

Description

Fix broken table in documentation

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

Scope

• This PR comprises a set of related changes with a common goal

If you cannot check the above box, please split your PR into multiple PRs that each have a common goal.

---

CodeAnt-AI Description

Fix broken table formatting in docs/case.md

What Changed

• Restored a broken markdown table in the Simulation Algorithm section so the Parameter / Type / Description columns render correctly
• Removed stray punctuation and misaligned table markers that prevented rows for boundary-condition parameters from displaying
• Boundary condition parameter entries (bc_[x,y,z]%%beg[end], bc_[x,y,z]%%vb[...], bc_[x,y,z]%%ve[...]) now appear as proper table rows with their types and descriptions

Impact

✅ Clearer boundary-condition documentation
✅ Easier discovery of parameter meanings
✅ Fewer documentation rendering issues

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

• Documentation
  • Updated the Simulation Algorithm section with a restructured parameters table featuring expanded descriptions and additional configuration options for enhanced clarity on available settings.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[codeant-ai]

CodeAnt AI is reviewing your PR.

---

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

[qodo-code-review]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Markdown Table Verify the updated table alignment renders correctly across the documentation toolchain (e.g., GitHub, any static site generator) and that the header alignment markers are intentional (right/center/left) for the displayed content. | Parameter | Type | Description | | ---: | :----: | :--- | | `bc_[x,y,z]%%beg[end]` | Integer | Beginning [ending] boundary condition in the $[x,y,z]$-direction (negative integer, see table [Boundary Conditions](#boundary-conditions)) | | `bc_[x,y,z]%%vb[1,2,3]`‡ | Real | Velocity in the (x,1), (y, 2), (z,3) direction applied to `bc_[x,y,z]%%beg` | | `bc_[x,y,z]%%ve[1,2,3]`‡ | Real | Velocity in the (x,1), (y, 2), (z,3) direction applied to `bc_[x,y,z]%%end` |

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

The Simulation Algorithm table in docs/documentation/case.md was reformatted with an expanded Parameter column. New parameter entries were added to document additional simulation options including mpp_lim, mixture_err, time_stepper, adap_dt variants, weno variants, and other numerical solver configurations without altering code logic.

Changes

Cohort / File(s)	Summary
Documentation docs/documentation/case.md	Reformatted and expanded "Simulation Algorithm" table with new parameter entries for numerical methods, time stepping, WENO schemes, MUSCL limiters, Riemann solvers, and physical models (surface tension, viscous, hypoelasticity, IGR)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Through docs we hop, with parameters clear,
Each WENO option and solver dear,
Time steppers, limiters, IGR galore—
Our simulation guide grows evermore! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The pull request description is incomplete and lacks substantial detail. While it identifies the change type and scope, it omits required sections like motivation/context, testing methodology, and specific test configurations.	Add details about what was broken in the table, why it needed fixing, describe how changes were tested, and complete relevant checklist items (especially the documentation checkbox since this modifies docs/).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'fix broken table in documentation' clearly and specifically describes the main change—fixing a broken table in documentation as evidenced by the raw summary showing table reformatting in docs/documentation/case.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

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

---

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

[codeant-ai]

CodeAnt AI finished reviewing your PR.

[codeant-ai]

💡 Enhance Your PR Reviews

We noticed that 3 feature(s) are not configured for this repository. Enabling these features can help improve your code quality and workflow:

🚦 Quality Gates

Status: Quality Gates are not enabled at the organization level
Learn more about Quality Gates

🎫 Jira Ticket Compliance

Status: Jira credentials file not found. Please configure Jira integration in your settings
Learn more about Jira Integration

⚙️ Custom Rules

Status: No custom rules configured. Add rules via organization settings or .codeant/review.json in your repository
Learn more about Custom Rules

---

Want to enable these features? Contact your organization admin or check our documentation for setup instructions.

[qodo-code-review]

Suggestion: Simplify the markdown table separator for the third column by removing unnecessary spaces to improve source code readability. [general, importance: 3]

Suggested change

	| ---: | :----: | :--- |
	| ---: | :----: | :--- |

[qodo-code-review]

Suggestion: Replace the line containing only spaces before the table with a truly empty line to ensure correct markdown parsing. [general, importance: 2]

Suggested change

[qodo-code-review]

Suggestion: Left-align the "Parameter" column in the markdown table by changing its alignment specifier from ---: to :--- for better readability. [general, importance: 5]

Suggested change

	| ---: | :----: | :--- |
	| :--- | :----: | :--- |

[cubic-dev-ai]

No issues found across 1 file