search

tataratat / splinepy

Library for prototyping spline geometries of arbitrary dimensions and degrees, and IGA
https://tataratat.github.io/splinepy
Other
45 stars 13 forks source link

v0.1.3 #454

Closed j042 closed 3 weeks ago

j042 commented 3 weeks ago

Overview

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes include an update to the version of the ruff-pre-commit repository, improvements to markdown file processing in a Python script, a modification in import order within a Jupyter Notebook, the addition of a new build command in pyproject.toml, an update to a method signature in C++, and an increment in the version number of the software package. These changes enhance various components of the project.

Changes

File Change Summary
.pre-commit-config.yaml Updated ruff-pre-commit version from v0.5.6 to v0.6.1.
docs/source/handle_markdown.py Refactored process_file to process line-by-line and added prepare_file_for_PyPI function.
examples/ipynb/notebook_showcase_k3d.ipynb Moved the import splinepy statement above import vedo.
pyproject.toml Added before_all command to execute python docs/source/handle_markdown.py -b before the build process.
splinepy/_version.py Updated version number from "0.1.2" to "0.1.3."
src/py/py_knot_vector.cpp Modified the __array__ method signature to include an additional [[maybe_unused]] py::kwargs copy_ignored parameter.
src/proximity/proximity.cpp Updated comments for clarity in PrepareIterationLevenbergMarquart method.
tests/test_proximity.py Renamed all_2p2d_splines to all_splines and expanded test coverage with additional 3D spline types.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant MarkdownProcessor
    participant BuildSystem

    User->>CLI: Run command to process markdown
    CLI->>MarkdownProcessor: Call process_file()
    MarkdownProcessor->>MarkdownProcessor: Process line-by-line
    MarkdownProcessor->>CLI: Return processed content
    CLI->>BuildSystem: Execute build with before_all command
    BuildSystem->>MarkdownProcessor: Call prepare_file_for_PyPI()

Poem

🐰 In the code, a hop and skip,
Changes made with a joyful flip!
Ruff now shines in version bright,
Markdown flows with newfound light.
A build command to guide the way,
Happy coding, hip-hip-hooray! 🎉

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.