DataArray.from_dict: convert docstring code to doctest

[code-review-doctor]

What happened?

This test is passing in a str for dims:

xarray/xarray/tests/test_dataarray.py

Lines 3074 to 3078 in 60754fd

	d = {"dims": ("t")}
	with pytest.raises(
	ValueError, match=r"cannot convert dict without the key 'data'"
	):
	DataArray.from_dict(d)

dims should be a tuple. I suspect the intent was to specify d = {"dims": ("t",)} when the test was written.

This is small issue, but tests that call functions using the kind of data that would be used in "live" will improve quality of tests. Would be a shame for bug to affect users because tests use a str while in userspace a tuple is used.

What did you expect to happen?

code to be d = {"dims": ("t",)}

Minimal Complete Verifiable Example

No response

Relevant log output

No response

Anything else we need to know?

I'm happy to make a PR to fix this

Environment

NA

[mathause]

This tests checks if the appropriate error is raised if the passed dict misses the key "data". So it does IMHO not really matter what is passed as dims.

[keewis]

this does indeed look like a typo (even though as @mathause says that value will not be checked because the absence of data is checked first) but in any case it is valid to pass a str: dims="t", dims=["t"] and dims=("t",) mean the same thing to the DataArray constructor for 1D data. Maybe we should just remove the parens to make this clear? I would have hoped that black takes care of something like that...

We also have the same issue in the docstring of DataArray.from_dict, which by the way would really benefit from converting the code block to a doctest-style example (it will fail right now).

[code-review-doctor]

I will make a PR to remove the paren to make the intent clearer 👍

Regarding black: worth also considering something like this to automatically highlight issues like this during PR :)

[mathause]

I updated the title of the issue to reflect the new state after #6139.

[code-review-doctor]

I have done an update to the docstring #6140

But note it is a minimal change rather than converting to doctest-style because I don't actually download or install xarray locally - I'm a bot that runs on AWS lambda to do static analysis checks on codebases for bugs. This repo was one of the 666 repos we run against when validating testing our new checkers.

As I do not have xarray setup locally I dont want to push larger code changes that have not been manually ran before I push, as there would be no confidence in the quality of the change :)

[keewis]

okay, thanks, we can take it from here.

Note that we have a CI to automatically run doctests, so you could in theory push to verify changes.