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

[python] Strip needless wrapper-class docstrings #3234

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

johnkerl
Copy link
Member

Issue and/or context: As tracked on issue #2407 / [sc-51048].

Note that the intended Python and R API changes are all agreed on and finalized as described in #2407.

Changes:

At present we have four layers:

  • User-facing Python like DataFrame
  • Wrappers in _tdb_handles.py
  • pybind11 as in apis/python/soma_dataframe.cc
  • libtiledbsoma as in libtiledbsoma/src/soma/soma_array.h

Throughout the new-shape project (#2407) I've been putting docstrings in the _tdb_handles.py layer which is silly because:

  • Users don't read them
  • It's double-keystroking on my part to write them (content is the same as in the user-facing layer)

Notes for Reviewer:

This PR is a work in progress. It is not ready for review.

@johnkerl
Copy link
Member Author

This was included in my merge of #3236 into main (inadvertently).

@johnkerl johnkerl merged commit 27b8e60 into kerl/cpp-ugr-dom-2 Oct 25, 2024
1 check passed
@johnkerl johnkerl deleted the kerl/docstring-prune branch October 25, 2024 16:17
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.

1 participant