search

nexpy / nexusformat

Provides an API to open, create, plot, and manipulate NeXus data.
Other
13 stars 19 forks source link

NXgroup.makelink: docstring typo? #197

Closed keara-soloway closed 1 year ago

keara-soloway commented 1 year ago

NXgroup.makelink's target parameter should be an NXobject. However, the docstring for that method has: https://github.com/nexpy/nexusformat/blob/441f750d0c6ae75d5f66cee5aaec9ad7f7cdbcc0/src/nexusformat/nexus/tree.py#L4869-L4872 which has caused some confusion in the past.

If this is not my misunderstanding, can this be resolved for next time the nexpy docs are built & deployed?

rayosborn commented 1 year ago

Thanks for raising the issue. I think at one point a path string must have been a valid argument but you are right that it is not any more. It's easy to fix.

keara-soloway commented 1 year ago

Okay, thanks!

rayosborn commented 1 year ago

Fixed by #198.