Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing entries in low-level API docs #1631

Closed
4 tasks done
takluyver opened this issue Aug 8, 2020 · 5 comments
Closed
4 tasks done

Missing entries in low-level API docs #1631

takluyver opened this issue Aug 8, 2020 · 5 comments

Comments

@takluyver
Copy link
Member

takluyver commented Aug 8, 2020

Including at least:

  • h5py.h5d functions
  • h5py.h5i functions
  • h5py.h5z functions
  • h5py.h5d.PropDAID

From #1620 (comment)

@takluyver
Copy link
Member Author

It looks like where we use

.. automodule:: h5py.h5i
    :members:

to document all functions in a module, it only includes functions which are declared in the relevant .pxd file. We either need to list the functions explicitly in the doc source (like we do for h5f and a number of other modules), or make sure they're in the .pxd file (like we do for h5pl).

@aragilar
Copy link
Member

aragilar commented Aug 8, 2020

Does :nodoc-members: help? I'm surprised that the .pxd file is used, I would have thought that would only be for the build, and not for runtime, or is something implicitly set on objects defined within the .pxd which is then reflected by them being found by sphinx?

@takluyver
Copy link
Member Author

h5d.open has a docstring, so it can't just be that.

I can never remember which bits of Sphinx use runtime introspection and which parse source code. I'm surprised that the pxd file matters as well, but it seems like it does!

@takluyver
Copy link
Member Author

Weirdly, today the functions are there. Either one of our recent PRs fixed it (#1624?), or it's an intermittent fault, or I was just somehow rather blind yesterday.

I'm going to reorganise the h5d page to better match other similar pages, with 'Functional API' at the top.

@takluyver
Copy link
Member Author

Done in #1637.

@takluyver takluyver added this to the 3.0 milestone Aug 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants