docs: Component method display

[lzeiml]

Internal ticket: 67

Core PR: siemens/ix#2652

Small adjustment to ensure the component methods get displayed correctly.

Summary by CodeRabbit

• Refactor
  • Improved the formatting and styling of API function descriptions and parameter details.
  • Enhanced presentation of optional parameter labels, types, and default values.
  • Preserved the existing API signature content and behavior.

[netlify]

✅ Deploy Preview for industrial-experience ready!

Name	Link
🔨 Latest commit	d022f4e
🔍 Latest deploy log	https://app.netlify.com/projects/industrial-experience/deploys/6a7b020aa3234c0008cac73f
😎 Deploy Preview	https://deploy-preview-270--industrial-experience.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7325065d-50c9-481f-8b67-95230d5af9cc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

ApiFunction preserves its signature output while restructuring description and parameter-row JSX with explicit styling wrappers, decoded type/default values, updated class composition, and a less constrained returns cell.

Changes

ApiFunction rendering

Layer / File(s)	Summary
Restructure signature and table rendering src/components/ApiTable/ApiFunction.tsx	Reformats signature construction, restructures description and parameter rows with styled labels and conditional optional/default markup, removes the returns-cell width constraint, and retains the default export identity.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• siemens/ix-docs#262: Reworks related ApiFunction signature and parameter-row JSX markup.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the documentation change that fixes component method display.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/component-methods

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/components/ApiTable/ApiFunction.tsx`:
- Around line 99-106: Update the default-value conditional in ApiFunction’s
parameter rendering to check whether param.defaultValue is undefined rather than
relying on truthiness, so explicitly empty strings still render the Default row
while omitted values remain hidden.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 83d71742-947b-4cce-b4c4-4ace26e91240

📥 Commits

Reviewing files that changed from the base of the PR and between 1f44ce1 and 1f66d08.

📒 Files selected for processing (1)

• src/components/ApiTable/ApiFunction.tsx