Skip to content

WIP: use sphinx_autodoc_typehints - #386

Open
basnijholt wants to merge 1 commit into
mainfrom
sphinx_autodoc_typehints
Open

WIP: use sphinx_autodoc_typehints#386
basnijholt wants to merge 1 commit into
mainfrom
sphinx_autodoc_typehints

Conversation

@basnijholt

Copy link
Copy Markdown
Member

Description

Please include a summary of the change and which (if so) issue is fixed.

Fixes #(ISSUE_NUMBER_HERE)

Checklist

  • Fixed style issues using pre-commit run --all (first install using pip install pre-commit)
  • pytest passed

Type of change

Check relevant option(s).

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • (Code) style fix or documentation update
  • This change requires a documentation update

@basnijholt
basnijholt force-pushed the sphinx_autodoc_typehints branch 2 times, most recently from 7f26f51 to f27bf7e Compare November 28, 2022 18:24
@codecov-commenter

codecov-commenter commented Nov 28, 2022

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 71.42857% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.84%. Comparing base (6c69e88) to head (f7816ba).
⚠️ Report is 70 commits behind head on main.

Files with missing lines Patch % Lines
adaptive/learner/learner1D.py 75.00% 1 Missing and 1 partial ⚠️
adaptive/learner/learner2D.py 60.00% 1 Missing and 1 partial ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #386      +/-   ##
==========================================
- Coverage   78.08%   77.84%   -0.24%     
==========================================
  Files          37       37              
  Lines        5525     5533       +8     
  Branches      989      991       +2     
==========================================
- Hits         4314     4307       -7     
- Misses       1064     1070       +6     
- Partials      147      156       +9     

☔ View full report in Codecov by Harness.
📢 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.

Comment on lines +36 to +42
try:
from typing import Literal
except ImportError:
# Remove this when we drop support for Python 3.7
from typing_extensions import Literal


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can drop 3.7, see https://numpy.org/neps/nep-0029-deprecation_policy.html

We didn't discuss this, but NEP 29 is a good source.

@basnijholt
basnijholt force-pushed the sphinx_autodoc_typehints branch from 66967c3 to f7816ba Compare December 4, 2022 04:47
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.

3 participants