-
Notifications
You must be signed in to change notification settings - Fork 248
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
[Documentation] Adding Registry
class documentation
#12928
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Documentation seems to be AI-generated and, in my opinion, is far from being useful for users. Indeed, there are some things wrong (e.g., the cpp layer is deliberately hidden from Python, so users do not need to distinguish the cpp and Python layers when retrieving).
It is AI assisted, but I reviewed. Currently there is no documentation at all, so if you need to use it you need to read the code and understand it. It took me 3 hours yesterday because without the Prototype word was not working and the error message wasnot giving any feedback. Tell me something you feel off and i will remove it. |
The documentation includes examples, I think people will appreciate it. |
OK. If you don't mind I would like to edit it a bit by myself. I agree that right now the EDIT: I'll try to find the time to make it soon. |
Feel free |
📝 Description
Adding
Registry
class documentation. ALso enhance the in code documentation of theRegistry
andRegistryItem
classes.🆕 Changelog
Registry
class documentationRegistry
class documentation with detailed descriptionsRegistryItem
class