-
Notifications
You must be signed in to change notification settings - Fork 59
Improve type hints and add py.typed files
#389
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
as the caption is not visible when the table is not rendered.
|
Thank you for making this pull request. Did you know? You can try it on Binder: Also, the version of ITables developed in this PR can be installed with (this requires |
py.typed filepy.typed files
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 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.formatsto includedocs/py///py:percentin all Markdown docs. - Inserted
remove-celllint-ignore code cells where Python exports are generated. - Added a
2.4.1-devsection toCHANGELOG.mdand 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
ITableshere but elsewhere styled asitables. 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
.mdfiles.
types: ["python"]
Codecov ReportAttention: Patch coverage is
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. 🚀 New features to boost your workflow:
|
This PR extends the typing coverage to the documentation. It also documents the type of (unset) default options.
Closes #224