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

[Documentation] Adding Registry class documentation #12928

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

loumalouomega
Copy link
Member

📝 Description

Adding Registry class documentation. ALso enhance the in code documentation of the Registry and RegistryItem classes.

🆕 Changelog

@loumalouomega loumalouomega added Kratos Core Documentation FastPR This Pr is simple and / or has been already tested and the revision should be fast labels Dec 11, 2024
@loumalouomega loumalouomega requested a review from a team as a code owner December 11, 2024 14:25
Copy link
Member

@rubenzorrilla rubenzorrilla left a 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).

@loumalouomega
Copy link
Member Author

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.

@loumalouomega
Copy link
Member Author

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 was not giving any feedback. Tell me something you feel off and i will remove it.

The documentation includes examples, I think people will appreciate it.

@rubenzorrilla
Copy link
Member

rubenzorrilla commented Dec 11, 2024

OK. If you don't mind I would like to edit it a bit by myself. I agree that right now the Registry is useless because no one knows how to fill it / use it.

EDIT: I'll try to find the time to make it soon.

@loumalouomega
Copy link
Member Author

OK. If you don't mind I would like to edit it a bit by myself. I agree that right now the Registry is useless because no one knows how to fill it / use it.

EDIT: I'll try to find the time to make it soon.

Feel free

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation FastPR This Pr is simple and / or has been already tested and the revision should be fast Kratos Core
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants