Skip to content

Conversation

trexfeathers
Copy link
Contributor

🚀 Pull Request

Description

A simple note in the documentation to suggest type hinting when contributing to the codebase. Moves us forward with #4272 / #4382 / #4383, since everyone seems in agreement.


Consult Iris pull request check list

@trexfeathers trexfeathers added the Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton label Nov 10, 2021
Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

I haven’t got involved in the discussions about type hinting, basically because I know very little about it. For the same reason, I think it would be quite a learning curve for me to include it in my PRs (and more work for the reviewer to set me straight when I get it wrong!)

That said, if a contributor is used to using type hints in other projects then it’s probably No Big Deal for them to also add them in Iris. So maybe just relax the language to indicate that type hints are encouraged but not compulsory?

@lbdreyer
Copy link
Member

This is looking good to me. Unless there are any objections I will merge this in by the end of the week

@lbdreyer
Copy link
Member

Oh dear! I was just about to merge this but I see there is now a conflict! @trexfeathers do you mind rebasing?

@lbdreyer lbdreyer merged commit 6d24b30 into SciTools:main Nov 23, 2021
tkknight added a commit to tkknight/iris that referenced this pull request Dec 7, 2021
* main: (23 commits)
  Suggest type hinting (SciTools#4390)
  area weight regrid test fixes (SciTools#4432)
  Update latest.rst (SciTools#4425)
  Added @wjbenfold to the core dev list (SciTools#4423)
  Removed addition of period from wrap_lons. (SciTools#4421)
  Add release docs sections describing the role of a Release Manager (SciTools#4413)
  Subset should always return None if no value matches are found (SciTools#4417)
  What's new for SciTools#4400 (SciTools#4422)
  `iris.analysis.AreaWeighted` regrid speedup (SciTools#4400)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4419)
  Remove newline to satisfy setuptools (SciTools#4418)
  Updated environment lockfiles (SciTools#4416)
  NAME loader fixes (SciTools#4411)
  Updated whatsnew for PR 4402 (SciTools#4410)
  Support test data in benchmark workflows (SciTools#4402)
  What's new for pr 4387 (SciTools#4405)
  Make concat mismatch warning for scalar coords more accurate (SciTools#4387)
  Added line to latest release notes for updates to pp_save_rules.py (SciTools#4404)
  Update pp_save_rules.py (SciTools#4391)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4403)
  ...
tkknight added a commit to tkknight/iris that referenced this pull request Dec 14, 2021
* upstream/main: (78 commits)
  Updated environment lockfiles (SciTools#4458)
  remove asv package dependency (SciTools#4456)
  cube.aggregated_by output bounds (SciTools#4315)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4452)
  Whatsnew (SciTools#4451)
  Explicitly define tests so nose can find them (SciTools#4450)
  Updated environment lockfiles (SciTools#4449)
  Update CI environment lockfiles (SciTools#4424)
  Disable GHA workflows on non-SciTools branches (SciTools#4444)
  Add new contributor to whatsnew (SciTools#4443)
  Use dask-core instead of dask in ci (SciTools#4434)
  Mesh recombine (SciTools#4437)
  Mesh full comparison (SciTools#4439)
  Only try to work out the differences between points for multiple (SciTools#4367)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4430)
  Fix license PyPI classifier (SciTools#4435)
  Whatsnew for PR SciTools#4367 (SciTools#4440)
  Suggest type hinting (SciTools#4390)
  area weight regrid test fixes (SciTools#4432)
  Update latest.rst (SciTools#4425)
  ...
@trexfeathers trexfeathers deleted the suggest_type_hinting branch March 31, 2022 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Experience: Low Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton Type: Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants