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

Convention wording #1426

Open
sebastienbeau opened this issue Oct 15, 2023 · 3 comments
Open

Convention wording #1426

sebastienbeau opened this issue Oct 15, 2023 · 3 comments

Comments

@sebastienbeau
Copy link
Contributor

Hi @shopinvader/shopinvader-maintainers

In several module we mix some wording shipping/delivery and billing/invoicing.

I propose to always use

  • delivery instead of shipping
  • invoicing instead of billing

What do you think ?

Second point regarding the naming of "helper" for router. I see that we do not have define a clear convention.

I propose "name_of_module.service.name_of_service" ?

For example for cart it's give you

shopinvader_api_cart.service.cart

For addresses

shopinvader_api_address.service.delivery_address
shopinvader_api_address.service.invoicing_address

Thanks for you feedback I will clean the code depending on the decision.

@sbidoul
Copy link
Member

sbidoul commented Oct 16, 2023

  • delivery instead of shipping
  • invoicing instead of billing

Sounds reasonable. No strong opinion about that from my side.

We could add a glossary in the wiki or somewhere?

shopinvader_api_cart.service.cart

Currently it's shopinvader_api_cart.routers.cart. I remember we discussed that after Valencia.
Have we written the rationale somewhere?

@lmignon
Copy link
Collaborator

lmignon commented Oct 16, 2023

  • delivery instead of shipping
  • invoicing instead of billing

👍

shopinvader_api_cart.service.cart

I would prefer to keep 'router' and 'helper' into the name. These odoo models are helpers for a specific pydantic router

-> shopinvader_api_cart.cart_router.helper: A helper model used by the endpoints of the cart_router.

@sebastienbeau
Copy link
Contributor Author

ok for me. I will change the name of the existing model

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants