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

Mention accuracy of Base.summarysize in docstring #55552

Open
xlxs4 opened this issue Aug 21, 2024 · 0 comments
Open

Mention accuracy of Base.summarysize in docstring #55552

xlxs4 opened this issue Aug 21, 2024 · 0 comments
Labels
docs This change adds or pertains to documentation

Comments

@xlxs4
Copy link
Contributor

xlxs4 commented Aug 21, 2024

From #32881 (comment):

Didn't we at some point explicitly state in the docs that it's a good-effort rough estimate and should not be relied upon? Or perhaps that was just a Jameson comment on GitHub that never got incorporated into the docs. In any case, it seems like we can improve the good-effort to best-effort in some places, and perhaps for the others we should document that it'll never be 100% perfect for the remainder.

While Base.summarysize is being improved upon (e.g., see #54606), it's not 100% accurate. Some example issues:

I saw there's people advocating for a better sizeof docstring (#54007). Do you think adding a note stating that summarysize isn't to be relied upon (and, ideally, in which cases it is accurate) is worth the effort? IMO this isn't clear enough as things currently stand.

@nsajko nsajko added the docs This change adds or pertains to documentation label Aug 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

2 participants