-
Notifications
You must be signed in to change notification settings - Fork 620
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
Conversation
There was a problem hiding this 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.
There was a problem hiding this 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 ...
No description provided.