Skip to content

Commit

Permalink
[IMP] pos_discount_all: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
peluko00 committed Dec 20, 2024
1 parent acb314b commit 5045b73
Show file tree
Hide file tree
Showing 16 changed files with 144 additions and 132 deletions.
98 changes: 52 additions & 46 deletions pos_discount_all/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,32 @@ Point of Sale - Display All Discounts
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
:target: https://github.com/OCA/pos/tree/16.0/pos_discount_all
:target: https://github.com/OCA/pos/tree/17.0/pos_discount_all
:alt: OCA/pos
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/pos-16-0/pos-16-0-pos_discount_all
:target: https://translation.odoo-community.org/projects/pos-17-0/pos-17-0-pos_discount_all
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/pos&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/pos&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of point of sale module, to
display on the PoS ticket, the amount of the discount applied for this sale.
Contrary to the logic of Odoo and the OCA
display on the PoS ticket, the amount of the discount applied for this
sale. Contrary to the logic of Odoo and the OCA
(https://github.com/OCA/sale-workflow/tree/14.0/sale_discount_display_amount)
the amount of the discount is the difference between the theoretical sale with the default price list and the actual sale amount.
So it take into accounts:
the amount of the discount is the difference between the theoretical
sale with the default price list and the actual sale amount. So it take
into accounts:

- explicit discount set on pos.order.line. (as for odoo ``sale`` module)
- fixed price set on pos.order.line
- discount generated by specific pricelist
- explicit discount set on pos.order.line. (as for odoo ``sale``
module)
- fixed price set on pos.order.line
- discount generated by specific pricelist

Also the module ignores in the computation of undiscounted amount lines, the
lines with a 'Discount Product'.
(see the configure section.)
Also the module ignores in the computation of undiscounted amount lines,
the lines with a 'Discount Product'. (see the configure section.)

**Table of contents**

Expand All @@ -51,29 +52,33 @@ lines with a 'Discount Product'.
Configuration
=============

* Go to "Point of Sale > Products"
* Create or edit your discount products
* Check the box "Is a Discount"
- Go to "Point of Sale > Products"
- Create or edit your discount products
- Check the box "Is a Discount"

.. image:: https://raw.githubusercontent.com/OCA/pos/16.0/pos_discount_all/static/description/product_template_form.png
|image|

.. |image| image:: https://raw.githubusercontent.com/OCA/pos/17.0/pos_discount_all/static/description/product_template_form.png

Usage
=====

Open your point of Sale

Make an order. for exemple,
- select the product 'Conference chair (39.40$)'
- select the pricelist -10%
- add a discount of 1$
Make an order. for exemple, - select the product 'Conference chair
(39.40$)' - select the pricelist -10% - add a discount of 1$

The total discount is 1$ + 10% \* 39.40 = 4.94$

The total discount is 1$ + 10% * 39.40 = 4.94$
|image_summary|

.. image:: https://raw.githubusercontent.com/OCA/pos/16.0/pos_discount_all/static/description/order_summary.png
Note, the discount displayed on the ticket is updated, to take into
account all the discount.

Note, the discount displayed on the ticket is updated, to take into account all the discount.
|image_receipt|

.. image:: https://raw.githubusercontent.com/OCA/pos/16.0/pos_discount_all/static/description/pos_receipt.png
.. |image_summary| image:: https://raw.githubusercontent.com/OCA/pos/17.0/pos_discount_all/static/description/order_summary.png
.. |image_receipt| image:: https://raw.githubusercontent.com/OCA/pos/17.0/pos_discount_all/static/description/pos_receipt.png

Development
===========
Expand All @@ -82,56 +87,57 @@ Development

In the javascript file, we could write

.. code-block:: javascript
const PosDiscountAllOrder = () =>
class extends Order {
}
.. code:: javascript
However, this code doesn't work if ``pos_sale`` module is installed. For that
reason we code the declaration as Odoo does, and add eslint exception.
const PosDiscountAllOrder = () =>
class extends Order {
}
However, this code doesn't work if ``pos_sale`` module is installed. For
that reason we code the declaration as Odoo does, and add eslint
exception.

.. code-block:: javascript
.. code:: javascript
// eslint-disable-next-line no-shadow
const PosDiscountAllOrder = (Order) =>
// eslint-disable-next-line no-shadow
class PosDiscountAllOrder extends Order {
}
// eslint-disable-next-line no-shadow
const PosDiscountAllOrder = (Order) =>
// eslint-disable-next-line no-shadow
class PosDiscountAllOrder extends Order {
}
Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_discount_all%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_discount_all%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~
-------

* GRAP

Contributors
~~~~~~~~~~~~
------------

* Sylvain LE GAL (https://twitter.com/legalsylvain)
- Sylvain LE GAL (https://twitter.com/legalsylvain)

Other credits
~~~~~~~~~~~~~
-------------

The development of this module has been financially supported by:

* UGESS, Union Nationale des Groupements des épiceries Sociales et Solidaires (https://ugess.org/)
- UGESS, Union Nationale des Groupements des épiceries Sociales et
Solidaires (https://ugess.org/)

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -151,6 +157,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-legalsylvain|

This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/16.0/pos_discount_all>`_ project on GitHub.
This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/17.0/pos_discount_all>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions pos_discount_all/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
5 changes: 5 additions & 0 deletions pos_discount_all/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- Go to "Point of Sale \> Products"
- Create or edit your discount products
- Check the box "Is a Discount"

![image](../static/description/product_template_form.png)
5 changes: 0 additions & 5 deletions pos_discount_all/readme/CONFIGURE.rst

This file was deleted.

1 change: 1 addition & 0 deletions pos_discount_all/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Sylvain LE GAL (<https://twitter.com/legalsylvain>)
1 change: 0 additions & 1 deletion pos_discount_all/readme/CONTRIBUTORS.rst

This file was deleted.

4 changes: 4 additions & 0 deletions pos_discount_all/readme/CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The development of this module has been financially supported by:

- UGESS, Union Nationale des Groupements des épiceries Sociales et
Solidaires (<https://ugess.org/>)
3 changes: 0 additions & 3 deletions pos_discount_all/readme/CREDITS.rst

This file was deleted.

14 changes: 14 additions & 0 deletions pos_discount_all/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
This module extends the functionality of point of sale module, to
display on the PoS ticket, the amount of the discount applied for this
sale. Contrary to the logic of Odoo and the OCA
(<https://github.com/OCA/sale-workflow/tree/14.0/sale_discount_display_amount>)
the amount of the discount is the difference between the theoretical
sale with the default price list and the actual sale amount. So it take
into accounts:

- explicit discount set on pos.order.line. (as for odoo `sale` module)
- fixed price set on pos.order.line
- discount generated by specific pricelist

Also the module ignores in the computation of undiscounted amount lines,
the lines with a 'Discount Product'. (see the configure section.)
14 changes: 0 additions & 14 deletions pos_discount_all/readme/DESCRIPTION.rst

This file was deleted.

21 changes: 21 additions & 0 deletions pos_discount_all/readme/DEVELOP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
**Note**

In the javascript file, we could write

``` javascript
const PosDiscountAllOrder = () =>
class extends Order {
}
```

However, this code doesn't work if `pos_sale` module is installed. For
that reason we code the declaration as Odoo does, and add eslint
exception.

``` javascript
// eslint-disable-next-line no-shadow
const PosDiscountAllOrder = (Order) =>
// eslint-disable-next-line no-shadow
class PosDiscountAllOrder extends Order {
}
```
21 changes: 0 additions & 21 deletions pos_discount_all/readme/DEVELOP.rst

This file was deleted.

13 changes: 13 additions & 0 deletions pos_discount_all/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Open your point of Sale

Make an order. for exemple, - select the product 'Conference chair
(39.40\$)' - select the pricelist -10% - add a discount of 1\$

The total discount is 1\$ + 10% \* 39.40 = 4.94\$

![image_summary](../static/description/order_summary.png)

Note, the discount displayed on the ticket is updated, to take into
account all the discount.

![image_receipt](../static/description/pos_receipt.png)
14 changes: 0 additions & 14 deletions pos_discount_all/readme/USAGE.rst

This file was deleted.

Loading

0 comments on commit 5045b73

Please sign in to comment.