Skip to content
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

Merged
merged 3 commits into from
Sep 4, 2024
Merged

Add row numbering for tables #26

merged 3 commits into from
Sep 4, 2024

Conversation

youandvern
Copy link
Owner

@youandvern youandvern commented Sep 4, 2024

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:

  • Introduce row numbering for tables, allowing rows to be numbered starting from 1.

Enhancements:

  • Add a new parameter 'numbered_rows' to the Table and InputTable classes to enable row numbering.

Documentation:

  • Update documentation to reflect the new 'numbered_rows' parameter in the Table and InputTable classes.
  • Update version number in documentation from 1.2.1 to 1.2.3.

Tests:

  • Add tests to verify the functionality of row numbering in tables, including scenarios with and without headers.

Chores:

  • Update README and documentation files to reflect the new version 1.2.3.

Copy link

sourcery-ai bot commented Sep 4, 2024

Reviewer's Guide by Sourcery

This 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

Change Details Files
Added row numbering functionality for tables
  • Introduced 'numbered_rows' parameter to Table and InputTable classes
  • Updated HTML generation to include row numbers when enabled
  • Added test cases for the new row numbering feature
  • Updated version number from 1.2.1 to 1.2.3
  • Modified documentation to include the new 'numbered_rows' parameter
efficalc/base_definitions/table.py
efficalc/generate_html.py
tests/test_generate_html.py
tests/base_definitions/test_table.py
docs/base_classes.html
Updated version numbers and documentation
  • Changed version number from 1.2.1 to 1.2.3 in multiple files
  • Updated documentation to reflect the new version
  • Modified README.md to update version badges
docs/_static/documentation_options.js
docs_src/conf.py
docs/searchindex.js
README.md
docs/base_classes.html
docs/calculation_helpers.html
docs/canvas.html
docs/constants.html
docs/examples.html
docs/figures.html
docs/get_started.html
docs/index.html
docs/integration.html
docs/math_operations.html
docs/purpose.html
docs/genindex.html
docs/py-modindex.html
docs/search.html
docs/section_properties.html
docs/styling.html
docs/testing.html

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@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 @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

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 to tell me if it was helpful.

Comment on lines +34 to +35
.. autoclass:: efficalc.Table
:members:
Copy link

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.

Suggested change
.. 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:
Copy link

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.

Comment on lines +15 to +16
.. autoclass:: efficalc.report_builder.LongCalcDisplayType
:members:
Copy link

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.

Suggested change
.. 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.

@youandvern youandvern merged commit 848e873 into main Sep 4, 2024
4 checks passed
@youandvern youandvern deleted the create-tables branch September 4, 2024 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant