docs: add example for cell

[njzjz]

Fix #2160.

Summary by CodeRabbit

• Documentation
  • Enhanced command-line help with new examples for usage scenarios.

[coderabbitai]

Walkthrough

Walkthrough

The recent update to the reacnetgenerator software includes enhancements to the command line interface, specifically in the commandline.py file. New examples have been added for the --type parameter with dump and xyz options, aimed at improving user guidance and experience.

Changes

File Path	Change Summary
reacnetgenerator/commandline.py	Added examples for --type dump and --type xyz

Assessment against linked issues

Objective	Addressed	Explanation
Provide a default format example for the --cell parameter in command line usage to address confusion (#2160)	❌	The changes do not include updates or examples related to the --cell parameter, which was specifically requested in the issue.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5896553 and 777ba59.

Files selected for processing (1)

• reacnetgenerator/commandline.py (1 hunks)

Additional comments not posted (1)

reacnetgenerator/commandline.py (1)

29-30: The added examples for --type dump and --type xyz are clear and well-placed within the epilog section of the ArgumentParser.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codspeed-hq]

CodSpeed Performance Report

Merging #2223 will not alter performance

_{Comparing njzjz:doc-example-cell (777ba59) with master (5896553)}

Summary

✅ 7 untouched benchmarks

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.17%. Comparing base (101610b) to head (777ba59).
Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2223      +/-   ##
==========================================
- Coverage   95.51%   95.17%   -0.34%     
==========================================
  Files          19       17       -2     
  Lines        1471     1431      -40     
==========================================
- Hits         1405     1362      -43     
- Misses         66       69       +3     

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