You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I would like to request the project maintainers to create a comprehensive CONTRIBUTING.md file that specifies the naming convention for the entities and functions in the codebase. I have come across some instances where it can be confusing and inconsistent to see names like authenticated_user, authorized_user, get_entity and get_entity_model that do not clearly indicate their types or purposes. Issue #115 also points out this problem. I suggest using names that are more descriptive and uniform, clearly indicating their return type.
Even something like get_entity_model and get_entity_dict might be a start. Of course, the final convention may be different and more refined than this, but I believe it would improve the readability and maintainability of the project. Please consider this suggestion. Thank you for your attention and hard work.
The text was updated successfully, but these errors were encountered:
I would like to request the project maintainers to create a comprehensive
CONTRIBUTING.md
file that specifies the naming convention for the entities and functions in the codebase. I have come across some instances where it can be confusing and inconsistent to see names likeauthenticated_user
,authorized_user
,get_entity
andget_entity_model
that do not clearly indicate their types or purposes. Issue #115 also points out this problem. I suggest using names that are more descriptive and uniform, clearly indicating their return type.Even something like
get_entity_model
andget_entity_dict
might be a start. Of course, the final convention may be different and more refined than this, but I believe it would improve the readability and maintainability of the project. Please consider this suggestion. Thank you for your attention and hard work.The text was updated successfully, but these errors were encountered: