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 GridProperty typing and update docstrings #942

Merged
merged 5 commits into from
Nov 6, 2023

Conversation

mferrera
Copy link
Collaborator

@mferrera mferrera commented Oct 26, 2023

Resolves #631
Resolves #889
Makes progress on #940

@codecov-commenter
Copy link

codecov-commenter commented Oct 27, 2023

Codecov Report

Merging #942 (46f9cae) into main (8ddc8b3) will decrease coverage by 0.05%.
The diff coverage is 84.84%.

@@            Coverage Diff             @@
##             main     #942      +/-   ##
==========================================
- Coverage   80.58%   80.53%   -0.05%     
==========================================
  Files          91       91              
  Lines       13481    13490       +9     
  Branches     2223     2220       -3     
==========================================
+ Hits        10863    10864       +1     
- Misses       1898     1904       +6     
- Partials      720      722       +2     
Files Coverage Δ
src/xtgeo/grid3d/_gridprop_value_init.py 86.11% <85.18%> (-1.07%) ⬇️
src/xtgeo/grid3d/_gridprop_op1.py 63.95% <61.53%> (-0.61%) ⬇️
src/xtgeo/grid3d/grid_property.py 85.26% <86.70%> (-0.91%) ⬇️

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

@mferrera mferrera force-pushed the mypy-gridproperty branch 3 times, most recently from 6bf2c9d to a804c2b Compare October 30, 2023 10:56
@mferrera mferrera changed the title WIP GridProperty typing / docstring updates Add GridProperty typing and update docstrings Oct 30, 2023
@mferrera mferrera marked this pull request as ready for review October 30, 2023 11:01
docs/apireference.rst Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
src/xtgeo/grid3d/_gridprop_value_init.py Outdated Show resolved Hide resolved
src/xtgeo/grid3d/_gridprop_value_init.py Show resolved Hide resolved
src/xtgeo/grid3d/grid_property.py Outdated Show resolved Hide resolved
src/xtgeo/grid3d/grid_property.py Show resolved Hide resolved
src/xtgeo/grid3d/grid_property.py Show resolved Hide resolved
src/xtgeo/grid3d/grid_property.py Show resolved Hide resolved
src/xtgeo/grid3d/grid_property.py Show resolved Hide resolved
src/xtgeo/grid3d/grid_property.py Show resolved Hide resolved
@mferrera mferrera force-pushed the mypy-gridproperty branch 4 times, most recently from 4b2e440 to 46f9cae Compare November 1, 2023 07:48
@mferrera mferrera requested review from janbjorge and tnatt November 3, 2023 06:40
Copy link
Collaborator

@jcrivenaes jcrivenaes left a comment

Choose a reason for hiding this comment

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

Looks great

Explicitly use `sphinx-autodoc-typehints` rather than its extension,
as the extension just installs it anyway. Also move autodoc options to
default options in `conf.py` and adjust some settings that fix
autodoc typehint resolution.
@mferrera mferrera merged commit 855f012 into equinor:main Nov 6, 2023
@mferrera mferrera deleted the mypy-gridproperty branch November 6, 2023 13:02
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.

Add type annotations to GridProperty Docs not building without constraint sphinx<4
4 participants