Skip to content

DOC: Array.resize examples are outdated #3503

New issue
New issue
Closed
Closed
DOC: Array.resize examples are outdated#3503
Labels
documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

Description

@ziw-liu
ziw-liu
opened on Oct 3, 2025

Describe the issue linked to the documentation

Examples do not match the signature:

zarr-python/src/zarr/core/array.py

Lines 4033 to 4048 in e0751ab

Examples
--------
>>> import zarr
>>> z = zarr.zeros(shape=(10000, 10000),
>>> chunk_shape=(1000, 1000),
>>> dtype="i4",)
>>> z.shape
(10000, 10000)
>>> z = z.resize(20000, 1000)
>>> z.shape
(20000, 1000)
>>> z2 = z.resize(50, 50)
>>> z.shape
(20000, 1000)
>>> z2.shape
(50, 50)

Suggested fix for documentation

Pass shape arguments as tuples.

Activity

  1. ziw-liu
    added
    help wantedIssue could use help from someone with familiarity on the topic
    documentationImprovements to the documentation
    on Oct 3, 2025

  2. ziw-liu commented on Oct 3, 2025

    @ziw-liu
    ziw-liu
    on Oct 3, 2025
    ContributorAuthor

    Likely due to #3498.

  3. ziw-liu commented on Oct 3, 2025

    @ziw-liu
    ziw-liu
    on Oct 3, 2025
    ContributorAuthor

    Yet checks added in #3500 are passing without any changes to this file. @d-v-b any ideas?

  4. d-v-b commented on Oct 3, 2025

    @d-v-b
    d-v-b
    on Oct 3, 2025
    Contributor

    i think this is not getting checked by #3500 because it's not annotated as a python code block. I will fix this particular instance, but there are probably many more examples

  5. d-v-b commented on Oct 3, 2025

    @d-v-b
    d-v-b
    on Oct 3, 2025
    Contributor

    this was addressed by #3500

  6. d-v-b
    closed this as completedon Oct 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions