datasets
datasets copied to clipboard
Fix docstrings and types in documentation that appears on the website
While I was working on https://github.com/huggingface/datasets/pull/5313 I've noticed that we have a mess in how we annotate types and format args and return values in the code. And some of it is displayed in the Reference section of the documentation on the website.
Would be nice someday, maybe before releasing datasets 3.0.0, to unify it......
I agree we have a mess with docstrings...
Ok, I believe we've cleaned up most of the old syntax we were using for the user-facing docs! There are still a couple of :obj:
's and :class:
floating around in the docstrings we don't expose that I'll track down :)
Hi @polinaeterna @albertvillanova @stevhliu, I hope you all are doing well.
Is this issue still unresolved as I am interested in it?
It should be mostly fixed for the user-facing APIs, but there may be some Sphinx syntax still lurking around in the non-public APIs. Feel free to open a PR to fix those if you catch any! 🤗
Thanks for your reply @stevhliu :) Sure, I will try to find out the remaining and fix that.