Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added deprecated message for k3d visualisation #534

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kzqureshi
Copy link
Contributor

@kzqureshi kzqureshi commented Nov 18, 2024

PR Type

documentation


Description

  • Added a deprecation message in the documentation for the k3d visualisation method, indicating it will be removed in future versions.
  • Recommended using PyVista for field visualisation instead of k3d.

Changes walkthrough 📝

Relevant files
Documentation
field-k3d-visualisation.ipynb
Add deprecation notice for `k3d` visualisation method       

docs/field-k3d-visualisation.ipynb

  • Added a deprecation note for the k3d visualisation method.
  • Suggested using PyVista as an alternative for field visualisation.
  • +3/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    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
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Consolidate the deprecation notice and browser recommendation into a single paragraph for clarity

    Consider consolidating the deprecation notice and the browser recommendation into a
    single, concise paragraph to improve readability and emphasis on the deprecation.

    docs/field-k3d-visualisation.ipynb [9-11]

    -"**Note:** The visualisation method using `k3d` is deprecated and will be removed in future versions, please use `PyVista` for visualising fields instead.\n",
    -"\n",
    -"If you experience any problems in plotting with `k3d`, please make sure you run the Jupyter notebook in Google Chrome.\n"
    +"**Note:** The `k3d` visualisation method is deprecated and will be removed in future versions. Please use `PyVista` for visualising fields. If you experience any issues with `k3d`, ensure you are using Google Chrome.\n"
    Suggestion importance[1-10]: 7

    Why: The suggestion improves readability and conciseness by combining related information into a single paragraph, which is beneficial for documentation clarity and user understanding.

    7

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant