Skip to content

Conversation

@EDCarman
Copy link
Contributor

@EDCarman EDCarman commented Jun 17, 2025

Description

Fix an issue with a malformed table that's causing the documentation build to fail.

Issue linked

N/A

Checklist

Summary by Sourcery

Documentation:

  • Correct table formatting in doc/source/examples/extended_examples/index.rst to resolve build failure

@EDCarman EDCarman self-assigned this Jun 17, 2025
@EDCarman EDCarman requested a review from a team as a code owner June 17, 2025 16:31
@EDCarman EDCarman requested review from clatapie and germa89 June 17, 2025 16:31
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 17, 2025

Reviewer's Guide

This PR resolves a documentation build error by correcting the reStructuredText table syntax in the Extended Examples index, ensuring proper header separators and column alignment.

File-Level Changes

Change Details Files
Fixed reST table formatting that caused the docs build to fail
  • Added missing delimiter row under the table headers
  • Ensured consistent column separators (
) throughout the table
  • Removed extraneous whitespace from table cells

  • 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!

    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

    @github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Jun 17, 2025
    @EDCarman
    Copy link
    Contributor Author

    @germa89 , it looks like the doc build for #4011 is still failing - this time it's my fault with a table that got broken during the corrections. This should fix it.

    @github-actions github-actions bot removed the documentation Documentation related (improving, adding, etc) label Jun 17, 2025
    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 @EDCarman - I've reviewed your changes and they look great!


    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.

    @github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Jun 17, 2025
    @EDCarman EDCarman closed this Jun 17, 2025
    @EDCarman
    Copy link
    Contributor Author

    @germa89 I see you beat me to it with #4016. Closing this one

    @EDCarman EDCarman deleted the docs/fix-malformed-table branch June 17, 2025 16:39
    @codecov
    Copy link

    codecov bot commented Jun 17, 2025

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 89.11%. Comparing base (a6e939a) to head (fd5fde1).
    Report is 4 commits behind head on main.

    Additional details and impacted files
    @@            Coverage Diff             @@
    ##             main    #4017      +/-   ##
    ==========================================
    - Coverage   89.12%   89.11%   -0.01%     
    ==========================================
      Files         187      187              
      Lines       14970    14970              
    ==========================================
    - Hits        13342    13341       -1     
    - Misses       1628     1629       +1     
    🚀 New features to boost your workflow:
    • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

    Labels

    documentation Documentation related (improving, adding, etc)

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants