-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add row numbering for tables #26
Conversation
Reviewer's Guide by SourceryThis pull request adds row numbering functionality for tables in the efficalc library. It introduces a new 'numbered_rows' parameter to the Table and InputTable classes, updates the HTML generation to include row numbers when enabled, and adds corresponding test cases. The changes also include version updates and documentation modifications to reflect the new feature. File-Level Changes
Tips
|
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.
Hey @youandvern - 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: 3 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
.. autoclass:: efficalc.Table | ||
:members: |
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.
suggestion (documentation): Consider adding a brief description for the Table class.
A short explanation of the class's purpose and usage could help users understand its role in the library.
.. autoclass:: efficalc.Table | |
:members: | |
.. autoclass:: efficalc.Table | |
:members: | |
The Table class represents a data structure for organizing and manipulating tabular data. | |
It provides methods for data input, manipulation, and analysis within the efficalc library. |
@@ -31,6 +31,14 @@ | |||
:members: | |||
|
|||
|
|||
.. autoclass:: efficalc.Table | |||
:members: |
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.
suggestion (documentation): Consider adding a brief description for the InputTable class.
A short explanation of how InputTable differs from Table and its specific use cases could be beneficial for users.
.. autoclass:: efficalc.InputTable
:members:
A specialized table for handling input data in efficalc.
Extends the base Table class with additional functionality
for data input and validation specific to efficiency calculations.
.. autoclass:: efficalc.report_builder.LongCalcDisplayType | ||
:members: |
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.
suggestion (documentation): Consider adding a brief description for the LongCalcDisplayType class.
A short explanation of this class's purpose and how it's used in the context of report building could enhance the documentation.
.. autoclass:: efficalc.report_builder.LongCalcDisplayType | |
:members: | |
.. autoclass:: efficalc.report_builder.LongCalcDisplayType | |
:members: | |
Defines display types for long calculations in report building. | |
This class provides options for formatting and presenting | |
detailed calculation steps in generated reports. |
Summary by Sourcery
Add row numbering feature to tables by introducing a 'numbered_rows' parameter in the Table and InputTable classes. Update documentation and tests to support this new feature, and increment the project version to 1.2.3.
New Features:
Enhancements:
Documentation:
Tests:
Chores: