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_dim_coord Documentation is misleading #178

Closed
pelson opened this issue Oct 25, 2012 · 0 comments
Closed

add_dim_coord Documentation is misleading #178

pelson opened this issue Oct 25, 2012 · 0 comments

Comments

@pelson
Copy link
Member

pelson commented Oct 25, 2012

The docs for
cube.add_dim_coord(dim_coord, data_dim=None):
state the following:

    Add a CF coordinate to the cube.

    Args:

        dim_coord

            The iris.coords.DimCoord instance to add to the cube.

    Kwargs:

        data_dim

            Integer giving the data dimension spanned by the coordinate.

    Raises a ValueError if a coordinate with identical metadata already exists on the cube or if a coord already exists for the given dimension.

    See also Cube.remove_coord().

However, data_dim is not an optional kwarg.

Please update the documentation for this method.

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

No branches or pull requests

2 participants