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

document that iris.coords.Coord is an ABC #3971

Merged
merged 2 commits into from
Feb 1, 2021

Conversation

bjlittle
Copy link
Member

@bjlittle bjlittle commented Jan 31, 2021

🚀 Pull Request

Description

This PR clarifies in the documentation that iris.coords.Coord is an abstract base class (ABC) as of iris 3.0.0, and therefore users cannot create an instance of it.

It also organises the end section of the whatsnew into two categories, one for entry author names, and the other for entry resources, using the rst only directive, see here.


Consult Iris pull request check list

@bjlittle
Copy link
Member Author

Closes #3967

@bjlittle bjlittle force-pushed the docs-abc-mention branch 2 times, most recently from 5c1098f to 5800e90 Compare January 31, 2021 23:26
@tkknight tkknight self-requested a review February 1, 2021 12:00
@tkknight tkknight merged commit 1e8ccdf into SciTools:master Feb 1, 2021
@bjlittle bjlittle deleted the docs-abc-mention branch February 1, 2021 13:03
tkknight added a commit to tkknight/iris that referenced this pull request Feb 1, 2021
* upstream/master:
  document that iris.coords.Coord is an ABC (SciTools#3971)
  reorganise docs common links + add core devs (SciTools#3972)
tkknight added a commit to tkknight/iris that referenced this pull request Feb 1, 2021
* master:
  remove explicit URLs for core dev names from latest.rst (SciTools#3973)
  document that iris.coords.Coord is an ABC (SciTools#3971)
  reorganise docs common links + add core devs (SciTools#3972)
  Docs whatsnew add dropdowns to the template (SciTools#3969)
  Docs whatsnew enumerated lists (SciTools#3970)
  Merge back v3p0p1 (SciTools#3966)
  Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963)
  Merge back v3p0p0 (SciTools#3960)
  Extended the installation description (SciTools#3958)
tkknight added a commit to tkknight/iris that referenced this pull request Feb 9, 2021
* master: (23 commits)
  Added text to state the Python version used to build the docs. (SciTools#3989)
  add nox session conda list (SciTools#3990)
  Add abstract cube summary (SciTools#3987)
  automate docs discovery of iris and python versions (SciTools#3981)
  corrected syntax (SciTools#3980)
  core dev whatsnew entry (SciTools#3978)
  moved docs dir and updated references to it (SciTools#3975)
  Fix test_incompatible_dimensions test (SciTools#3977)
  remove explicit URLs for core dev names from latest.rst (SciTools#3973)
  document that iris.coords.Coord is an ABC (SciTools#3971)
  reorganise docs common links + add core devs (SciTools#3972)
  Docs whatsnew add dropdowns to the template (SciTools#3969)
  Docs whatsnew enumerated lists (SciTools#3970)
  Merge back v3p0p1 (SciTools#3966)
  Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963)
  Merge back v3p0p0 (SciTools#3960)
  Extended the installation description (SciTools#3958)
  Put cube data on the x axis if plotting just a cube against a vertical or y coordinate (SciTools#3906)
  remove stock_mdi_arrays.npz (SciTools#3913)
  Gallery: update seasonal ensemble example (SciTools#3933)
  ...
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.

2 participants