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

WIP: use sphinx_autodoc_typehints #386

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

basnijholt
Copy link
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
Copy link

codecov-commenter commented Nov 28, 2022

Codecov Report

Merging #386 (f7816ba) into main (6c69e88) will decrease coverage by 0.23%.
The diff coverage is 71.42%.

@@            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     
Impacted Files Coverage Δ
adaptive/learner/learner2D.py 76.03% <60.00%> (-0.49%) ⬇️
adaptive/learner/learner1D.py 86.92% <75.00%> (-0.80%) ⬇️
adaptive/runner.py 68.80% <100.00%> (-0.59%) ⬇️
adaptive/_version.py 45.61% <0.00%> (-3.51%) ⬇️
adaptive/learner/average_learner1D.py 73.75% <0.00%> (-1.00%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

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

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.

None yet

3 participants