Skip to content

[doc] Update documentation links and improve content in notebooks#14

Merged
chaoming0625 merged 3 commits intomainfrom
docs
Apr 19, 2025
Merged

[doc] Update documentation links and improve content in notebooks#14
chaoming0625 merged 3 commits intomainfrom
docs

Conversation

@Routhleck
Copy link
Collaborator

@Routhleck Routhleck commented Apr 18, 2025

This pull request updates various documentation files to fix outdated or incorrect URLs, ensuring they point to the correct locations in the saiunit documentation. The changes primarily involve removing /en/latest from the URLs and updating paths to match the current structure of the documentation.

Updates to Documentation URLs:

  • General Documentation Links:

    • Updated the saiunit and brainunit README files to remove /en/latest from the ReadTheDocs links for documentation badges. (README.md: [1] brainunit/README.md: [2]
  • Physical Units Documentation:

    • Fixed the link to the Quantity documentation in the FAQs to point to the correct path. (docs/FAQs.md: docs/FAQs.mdL95-R95)
    • Updated links in the math_operations_with_quantity and quantity notebooks to remove /en/latest and reflect the updated documentation structure. (docs/physical_units/math_operations_with_quantity.ipynb: [1] docs/physical_units/quantity.ipynb: [2] [3]
  • Mathematical Functions Documentation:

    • Updated links in the fft_functions, lax_functions, linalg_functions, and numpy_functions notebooks to remove /en/latest and ensure paths align with the updated documentation structure. (docs/mathematical_functions/fft_functions.ipynb: [1] docs/mathematical_functions/lax_functions.ipynb: [2] docs/mathematical_functions/linalg_functions.ipynb: [3] docs/mathematical_functions/numpy_functions.ipynb: [4] [5] [6] [7] [8] [9] [10] [11]
  • Advanced Tutorials:

These changes improve the accuracy and usability of the documentation by ensuring all links are functional and up-to-date.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 18, 2025

Reviewer's Guide by Sourcery

This pull request updates a broken link in the FAQ documentation. The old link pointed to a brainunit URL, but it should point to the saiunit URL.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the URL for the Quantity documentation in the FAQ.
  • Replaced the old brainunit URL with the correct saiunit URL.
docs/FAQs.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@Routhleck Routhleck requested a review from chaoming0625 April 18, 2025 10:58
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Routhleck - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Routhleck Routhleck changed the title [doc] Update FAQ link for saiunit documentation [doc] Update documentation links and improve content in notebooks Apr 18, 2025
@chaoming0625 chaoming0625 merged commit 7ec81d3 into main Apr 19, 2025
30 checks passed
@chaoming0625 chaoming0625 deleted the docs branch April 19, 2025 03:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants