Skip to content

Documentation: Elaborates on Table related classes. #4563

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

Merged
merged 4 commits into from
Jun 17, 2025

Conversation

jamie-lemon
Copy link
Collaborator

No description provided.

@jamie-lemon jamie-lemon requested review from JorjMcKie and Copilot June 16, 2025 16:31
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation for table-related classes in the project, providing clearer Sphinx directives and more detailed attribute and method descriptions.

  • Improved Sphinx markup for Page-level methods.
  • Enhanced attribute and method documentation for Table, TableHeader, and TableRow classes.
  • Added clarifying notes and type annotations for better readability and consistency.
Comments suppressed due to low confidence (2)

docs/page.rst:2386

  • The type annotation for the 'page' attribute in the Table class is set as a string. If this attribute actually represents a Page object, consider updating it to :class:Page to match its intended usage.
:type: `string`

docs/page.rst:2440

  • The documentation for the to_markdown() method suggests that table data is extracted into a list, yet the return type is marked as a string. Please clarify whether this method returns a markdown string or a list, and update the description and :type: annotation accordingly.
Extracts table data into a list.

Copy link
Collaborator

@JorjMcKie JorjMcKie left a comment

Choose a reason for hiding this comment

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

There are several corrections ...

@JorjMcKie JorjMcKie self-requested a review June 17, 2025 09:32
@jamie-lemon jamie-lemon merged commit 78b39c1 into main Jun 17, 2025
2 checks passed
@jamie-lemon jamie-lemon deleted the pages-class-docs-tweak branch June 17, 2025 11:44
@github-actions github-actions bot locked and limited conversation to collaborators Jun 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants