Skip to content

Documentation consistency with the Python interface #81

@dorchard

Description

@dorchard

This might be a question of updating the docs, but I notice that the description of the BMI interface for get_value in Python says that
it should return None: https://bmi.csdms.io/en/stable/bmi.getter_setter.html#get-value

But the Python abstract class description has it returning an NDArray:

def get_value(self, name: str, dest: NDArray[Any]) -> NDArray[Any]:

In contrast, set_value returns None

def set_value(self, name: str, src: NDArray[Any]) -> None:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions