Skip to content

Conversation

@ablot
Copy link

@ablot ablot commented Nov 11, 2025

Updated device reader examples to use 'device.yml' instead of 'device.harp' to match the file description above.

Updated device reader examples to use 'device.yml' instead of 'device.harp' to match the file description above.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@bruno-f-cruz
Copy link
Member

The current documentation is consistent with the function signature and documentation:

harp-python/harp/reader.py

Lines 242 to 244 in 3d97d0b

device
A path to the device schema, dataset folder, or parsed device schema object
describing the device.

While you can pass a device.yml, the "canonical" use is actually to pass a full folder since the reader can infer the path to all the files. We are trying to expand the current API via #26 to make this a bit more explicit by using different factories for the reader.

I will close this PR for now, but feel free to open an issue if you want to continue the discussion!

Thanks :)

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

Successfully merging this pull request may close these issues.

3 participants