Skip to content

Conversation

@mwouts
Copy link
Owner

@mwouts mwouts commented May 30, 2025

This PR extends the typing coverage to the documentation. It also documents the type of (unset) default options.

Closes #224

@github-actions
Copy link

Thank you for making this pull request.

Did you know? You can try it on Binder: Binder:lab.

Also, the version of ITables developed in this PR can be installed with pip:

pip install git+https://github.com/mwouts/itables.git@improve_type_hints

(this requires nodejs, see more at Developing ITables)

@mwouts mwouts changed the title Improve type hints and add py.typed file Improve type hints and add py.typed files May 30, 2025
@mwouts mwouts requested a review from Copilot May 30, 2025 21:49
Copy link

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 standardizes Jupytext metadata across documentation, adds lint-ignore code cells for generated Python docs, updates the changelog for a new dev release, and revises the pre-commit Jupytext hook.

  • Expanded jupytext.formats to include docs/py///py:percent in all Markdown docs.
  • Inserted remove-cell lint-ignore code cells where Python exports are generated.
  • Added a 2.4.1-dev section to CHANGELOG.md and modified the pre-commit hook to use Jupytext’s sync mode.

Reviewed Changes

Copilot reviewed 94 out of 94 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/options/colvis.md Include Python percent format in Jupytext metadata
docs/options/column_filters.md Include Python percent format in Jupytext metadata
docs/options/column_defs.md Include Python percent format in Jupytext metadata; add lint-ignore code cell
docs/options/classes.md Include Python percent format in Jupytext metadata
docs/options/caption.md Include Python percent format in Jupytext metadata
docs/options/buttons.md Include Python percent format in Jupytext metadata
docs/options/allow_html.md Include Python percent format in Jupytext metadata
docs/formatting.md Include Python percent format in Jupytext metadata; add lint-ignore code cell
docs/downsampling.md Include Python percent format in Jupytext metadata; add lint-ignore code cell
docs/dark_mode.md Include Python percent format in Jupytext metadata
docs/custom_extensions.md Include Python percent format in Jupytext metadata
docs/css.md Include Python percent format in Jupytext metadata; add lint-ignore code cell
docs/contributing.md Include Python percent format in Jupytext metadata
docs/changelog.md Added 2.4.1-dev section with Added/Changed/Fixed entries
docs/apps/widget.md Include Python percent format in Jupytext metadata; add lint-ignore code cell
docs/apps/notebook.md Include Python percent format in Jupytext metadata
docs/apps/marimo.md Include Python percent format in Jupytext metadata
docs/apps/html.md Include Python percent format in Jupytext metadata
docs/apps/dash.md Include Python percent format in Jupytext metadata
.pre-commit-config.yaml Changed Jupytext hook to --sync; limited to Python files
Comments suppressed due to low confidence (3)

docs/changelog.md:7

  • [nitpick] The project name is written as ITables here but elsewhere styled as itables. Consider normalizing capitalization for consistency.
**Added**

docs/options/column_defs.md:15

  • [nitpick] The lint-ignore code-cell insertion pattern (tags and comment directives) varies between files. Consider defining a single template or snippet to ensure consistency across all documentation exports.
```{code-cell} ipython3

.pre-commit-config.yaml:36

  • Restricting the Jupytext hook to only Python files may skip lint-syncs on Markdown docs; verify that documentation exports are still covered or add a separate hook for .md files.
      types: ["python"]

@codecov-commenter
Copy link

codecov-commenter commented May 30, 2025

Codecov Report

Attention: Patch coverage is 97.05882% with 2 lines in your changes missing coverage. Please review.

Project coverage is 88.91%. Comparing base (9923305) to head (5b3c4a4).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/itables/javascript.py 75.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #389      +/-   ##
==========================================
- Coverage   88.93%   88.91%   -0.02%     
==========================================
  Files          44       44              
  Lines        1799     1832      +33     
==========================================
+ Hits         1600     1629      +29     
- Misses        199      203       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mwouts mwouts marked this pull request as ready for review May 31, 2025 11:46
@mwouts mwouts merged commit 6da378b into main May 31, 2025
14 checks passed
@mwouts mwouts deleted the improve_type_hints branch May 31, 2025 11:53
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.

Need add type hint for itables.options.lengthMenu

3 participants