Documentation: Elaborates on Table related classes.#4563
Merged
Conversation
Contributor
There was a problem hiding this comment.
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:
Pageto 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.
JorjMcKie
reviewed
Jun 16, 2025
JorjMcKie
reviewed
Jun 16, 2025
JorjMcKie
reviewed
Jun 16, 2025
JorjMcKie
reviewed
Jun 16, 2025
JorjMcKie
reviewed
Jun 16, 2025
JorjMcKie
reviewed
Jun 16, 2025
JorjMcKie
requested changes
Jun 16, 2025
Collaborator
JorjMcKie
left a comment
There was a problem hiding this comment.
There are several corrections ...
JorjMcKie
approved these changes
Jun 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.