Skip to content

Conversation

rcomer
Copy link
Member

@rcomer rcomer commented Apr 16, 2021

🚀 Pull Request

Description

Resolves #4085. Docstrings now show arguments' types on the line above their description, so they render sensibly in readthedocs.


Consult Iris pull request check list

@rcomer
Copy link
Member Author

rcomer commented Apr 16, 2021

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

I can confirm that this now renders correctly, and that you didn't miss any. Thanks for your diligence @rcomer!

@trexfeathers
Copy link
Contributor

Waiting on #4104.

@rcomer rcomer force-pushed the iplot-docstrings branch from 7f4ab02 to f41cefa Compare May 5, 2021 15:40
@rcomer
Copy link
Member Author

rcomer commented May 5, 2021

@trexfeathers ready to go 😁

@trexfeathers trexfeathers merged commit 34b467b into SciTools:master May 6, 2021
@rcomer rcomer deleted the iplot-docstrings branch May 6, 2021 09:41
tkknight added a commit to tkknight/iris that referenced this pull request May 17, 2021
* master: (49 commits)
  Update CI environment lockfiles + Cartopy 0.19 changes (SciTools#4125)
  separate arg types from descriptions (SciTools#4100)
  Use assertArrayAllClose for sqrt test (SciTools#4118)
  Removed branch suffix (SciTools#4117)
  Corrected plot_anomaly_log_colouring for new Matplotlib linscale rules. (SciTools#4115)
  replace most recent hashes (SciTools#4112)
  Linkcheck update (SciTools#4104)
  CI lockfiles (SciTools#4108)
  Fix bug in gallery_tests runner (SciTools#4111)
  add logo to conda and pypi badges (SciTools#4088)
  pre-commit-ci update (SciTools#4092)
  Fix cirrus ci and mpl (SciTools#4087)
  Update readme docs stable (SciTools#4089)
  linux kernel version fix for conda 4.10+ (SciTools#4084)
  update docs pypi instructions (SciTools#4077)
  update flake8 pre-commit (SciTools#4067)
  Add GitHub discussions badge (SciTools#4070)
  conda requirements add pip (SciTools#4062)
  add pre-commit.ci badge and doc support (SciTools#4061)
  cirrus-ci credits for non-master (SciTools#4060)
  ...
tkknight added a commit to tkknight/iris that referenced this pull request May 26, 2021
* master: (87 commits)
  Contourf Antialias Fix (SciTools#4150)
  minor tidy of cirrus and nox (SciTools#4152)
  update bug and feature templates (SciTools#4147)
  Update CI environment lockfiles + Cartopy 0.19 changes (SciTools#4125)
  separate arg types from descriptions (SciTools#4100)
  Use assertArrayAllClose for sqrt test (SciTools#4118)
  Removed branch suffix (SciTools#4117)
  Corrected plot_anomaly_log_colouring for new Matplotlib linscale rules. (SciTools#4115)
  replace most recent hashes (SciTools#4112)
  Linkcheck update (SciTools#4104)
  CI lockfiles (SciTools#4108)
  Fix bug in gallery_tests runner (SciTools#4111)
  add logo to conda and pypi badges (SciTools#4088)
  pre-commit-ci update (SciTools#4092)
  Fix cirrus ci and mpl (SciTools#4087)
  Update readme docs stable (SciTools#4089)
  linux kernel version fix for conda 4.10+ (SciTools#4084)
  update docs pypi instructions (SciTools#4077)
  update flake8 pre-commit (SciTools#4067)
  Add GitHub discussions badge (SciTools#4070)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

iris.plot arguments
2 participants