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

Next to all documentation for decompression_executor and interpretation_executor, warn about limited usefulness #1165

Open
jpivarski opened this issue Mar 8, 2024 · 0 comments
Labels
docs Improvements or additions to documentation

Comments

@jpivarski
Copy link
Member

Especially in uproot.dask, where such use implies nested parallelism and the dangers of that.

They shouldn't be very detailed results, since there isn't room for that in a single-line argument documentation, but just give a number (1 or 2 significant figures) in the best cases and indicate which those are:

  • decompression_executor for LZMA-compressed data, large TBaskets
  • interpretation_executor for AsObjects interpretations that can be successfully interpreted with AwkwardForth (without a deep discussion of what that means; hopefully, web-search will help the curious)
@jpivarski jpivarski added the docs Improvements or additions to documentation label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant