Skip to content

Inconsistency in download_version function documentation #829

Open

Description

@PaulinCharliquart

hi,

The download_version function documentation mentions a parameter called ... (ellipsis) that appears in the function signature but is not actually utilized within the function implementation.

Image

However, these additional arguments are not used anywhere in the function body, potentially misleading users about the function's capabilities.

kind regards,
Paulin

Activity

  1. tanmaydimriGSOC commented on Dec 9, 2025

    @tanmaydimriGSOC

    Hi ,

    I'd like to fix this documentation inconsistency.

    I'll investigate whether the ... parameter:

    1. Should be removed from the function signature (if truly unused)
    2. Should be documented with a note explaining it's reserved for future use
    3. Should be passed to an internal function

    I'll check the codebase and submit a PR once I understand the intended behavior.

    Can I work on this issue?

    Thanks!

  2. gaborcsardi commented on Dec 9, 2025

    @gaborcsardi
    Member

    Thanks! It should be passed on.

  3. tanmaydimriGSOC commented on Dec 9, 2025

    @tanmaydimriGSOC

    Got it! Thanks for clarifying.

    I'll pass the ... parameter to the appropriate internal function call. I'll check which function(s) inside download_version() should receive these arguments and submit a PR.

    I'll get started on this today!

  4. added a commit that references this issue on Dec 10, 2025
    ee85c14
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

    bugan unexpected problem or unintended behaviordocumentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions