[IMP] web_widget_product_label_section_and_note: pre-commit auto fixes

OCA · Feb 5, 2025 · 10bd32b · 10bd32b
1 parent e587546
commit 10bd32b
Show file tree

Hide file tree

Showing 11 changed files with 75 additions and 52 deletions.
diff --git a/web_widget_product_label_section_and_note/README.rst b/web_widget_product_label_section_and_note/README.rst
@@ -17,18 +17,19 @@ Web widget product label section and note
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
-    :target: https://github.com/OCA/web/tree/16.0/web_widget_product_label_section_and_note
+    :target: https://github.com/OCA/web/tree/17.0/web_widget_product_label_section_and_note
     :alt: OCA/web
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_widget_product_label_section_and_note
+    :target: https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_widget_product_label_section_and_note
     :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/web&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=17.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module unifies the product and name into a single column, making it more user-friendly and space-saving.
+This module unifies the product and name into a single column, making it
+more user-friendly and space-saving.
 
 **Table of contents**
 
@@ -39,57 +40,62 @@ Configuration
 =============
 
 To extend this functionality to other modules (for example, Purchase),
-in a new module, it is necessary to create an inherited view to change the widget for these fields:
+in a new module, it is necessary to create an inherited view to change
+the widget for these fields:
 
-- `one2many` field with `widget="product_label_section_and_note_field_o2m"`.
-
-- `product_id` or product_tmpl_id field with `widget="product_label_section_and_note_field"`.
-
-- `name` field with `widget="section_and_note_text"`.
+- one2many field with widget="product_label_section_and_note_field_o2m".
+- product_id or producttmpl_id field with
+  widget="product_label_section_and_note_field".
+- name field with widget="section_and_note_text".
 
 Usage
 =====
 
 - Go to the **Invoicing > Customers > Invoices** and add a new line.
 - The product label must be displayed just after the product name.
-- If the product does not have a description, a button must be displayed to add one.
+- If the product does not have a description, a button must be displayed
+  to add one.
 
 Known issues / Roadmap
 ======================
 
-- Add compatibility with `sale_product_configurator` module
-- Add compatibility with `purchase_product_matrix` module
-- When this module is installed, the PDF report will always display the column `name` as a combination of the `product code`, `product name`, and `description`. This behavior may differ from the expected behavior, where only the column `name` is displayed and can be customized independently.
+- Add compatibility with sale_product_configurator module
+- Add compatibility with purchase_product_matrix module
+- When this module is installed, the PDF report will always display the
+  column name as a combination of the product code, product name, and
+  description. This behavior may differ from the expected behavior,
+  where only the column name is displayed and can be customized
+  independently.
 
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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/web/issues/new?body=module:%20web_widget_product_label_section_and_note%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_product_label_section_and_note%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
-~~~~~~~
+-------
 
 * Tecnativa
 * Odoo S.A.
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* `Tecnativa <https://www.tecnativa.com>`_:
+- `Tecnativa <https://www.tecnativa.com>`__:
 
-    * Pedro M. Baeza
-    * Carlos Lopez
+     - Pedro M. Baeza
+     - Carlos Lopez
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -101,6 +107,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-This module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_widget_product_label_section_and_note>`_ project on GitHub.
+This module is part of the `OCA/web <https://github.com/OCA/web/tree/17.0/web_widget_product_label_section_and_note>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
diff --git a/web_widget_product_label_section_and_note/pyproject.toml b/web_widget_product_label_section_and_note/pyproject.toml
@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"
diff --git a/web_widget_product_label_section_and_note/readme/CONFIGURE.md b/web_widget_product_label_section_and_note/readme/CONFIGURE.md
@@ -0,0 +1,8 @@
+To extend this functionality to other modules (for example, Purchase),
+in a new module, it is necessary to create an inherited view to change
+the widget for these fields:
+
+- one2many field with widget="product_label_section_and_note_field_o2m".
+- product_id or producttmpl_id field with
+  widget="product_label_section_and_note_field".
+- name field with widget="section_and_note_text".
diff --git a/web_widget_product_label_section_and_note/readme/CONFIGURE.rst b/web_widget_product_label_section_and_note/readme/CONFIGURE.rst
diff --git a/web_widget_product_label_section_and_note/readme/CONTRIBUTORS.md b/web_widget_product_label_section_and_note/readme/CONTRIBUTORS.md
@@ -0,0 +1,4 @@
+- [Tecnativa](https://www.tecnativa.com):
+
+  > - Pedro M. Baeza
+  > - Carlos Lopez
diff --git a/web_widget_product_label_section_and_note/readme/CONTRIBUTORS.rst b/web_widget_product_label_section_and_note/readme/CONTRIBUTORS.rst
diff --git a/...l_section_and_note/readme/DESCRIPTION.rst → ...el_section_and_note/readme/DESCRIPTION.md b/...l_section_and_note/readme/DESCRIPTION.rst → ...el_section_and_note/readme/DESCRIPTION.md
@@ -1 +1,2 @@
-This module unifies the product and name into a single column, making it more user-friendly and space-saving.
+This module unifies the product and name into a single column, making it
+more user-friendly and space-saving.
diff --git a/web_widget_product_label_section_and_note/readme/ROADMAP.md b/web_widget_product_label_section_and_note/readme/ROADMAP.md
@@ -0,0 +1,7 @@
+- Add compatibility with sale_product_configurator module
+- Add compatibility with purchase_product_matrix module
+- When this module is installed, the PDF report will always display the
+  column name as a combination of the product code, product name, and
+  description. This behavior may differ from the expected behavior,
+  where only the column name is displayed and can be customized
+  independently.
diff --git a/web_widget_product_label_section_and_note/readme/ROADMAP.rst b/web_widget_product_label_section_and_note/readme/ROADMAP.rst
diff --git a/...t_label_section_and_note/readme/USAGE.rst → ...ct_label_section_and_note/readme/USAGE.md b/...t_label_section_and_note/readme/USAGE.rst → ...ct_label_section_and_note/readme/USAGE.md
@@ -1,3 +1,4 @@
-- Go to the **Invoicing > Customers > Invoices** and add a new line.
+- Go to the **Invoicing \> Customers \> Invoices** and add a new line.
 - The product label must be displayed just after the product name.
-- If the product does not have a description, a button must be displayed to add one.
+- If the product does not have a description, a button must be displayed
+  to add one.
diff --git a/web_widget_product_label_section_and_note/static/description/index.html b/web_widget_product_label_section_and_note/static/description/index.html
@@ -369,8 +369,9 @@ <h1 class="title">Web widget product label section and note</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:db9a30e28410d3ef4ad626f850f766eedb3845976f424d1bbae3350674397d0d
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/web/tree/16.0/web_widget_product_label_section_and_note"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_widget_product_label_section_and_note"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/web&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>This module unifies the product and name into a single column, making it more user-friendly and space-saving.</p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/web/tree/17.0/web_widget_product_label_section_and_note"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_widget_product_label_section_and_note"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/web&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p>This module unifies the product and name into a single column, making it
+more user-friendly and space-saving.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -389,35 +390,42 @@ <h1 class="title">Web widget product label section and note</h1>
 <div class="section" id="configuration">
 <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <p>To extend this functionality to other modules (for example, Purchase),
-in a new module, it is necessary to create an inherited view to change the widget for these fields:</p>
+in a new module, it is necessary to create an inherited view to change
+the widget for these fields:</p>
 <ul class="simple">
-<li><cite>one2many</cite> field with <cite>widget=”product_label_section_and_note_field_o2m”</cite>.</li>
-<li><cite>product_id</cite> or product_tmpl_id field with <cite>widget=”product_label_section_and_note_field”</cite>.</li>
-<li><cite>name</cite> field with <cite>widget=”section_and_note_text”</cite>.</li>
+<li>one2many field with widget=”product_label_section_and_note_field_o2m”.</li>
+<li>product_id or producttmpl_id field with
+widget=”product_label_section_and_note_field”.</li>
+<li>name field with widget=”section_and_note_text”.</li>
 </ul>
 </div>
 <div class="section" id="usage">
 <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 <ul class="simple">
 <li>Go to the <strong>Invoicing &gt; Customers &gt; Invoices</strong> and add a new line.</li>
 <li>The product label must be displayed just after the product name.</li>
-<li>If the product does not have a description, a button must be displayed to add one.</li>
+<li>If the product does not have a description, a button must be displayed
+to add one.</li>
 </ul>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
 <ul class="simple">
-<li>Add compatibility with <cite>sale_product_configurator</cite> module</li>
-<li>Add compatibility with <cite>purchase_product_matrix</cite> module</li>
-<li>When this module is installed, the PDF report will always display the column <cite>name</cite> as a combination of the <cite>product code</cite>, <cite>product name</cite>, and <cite>description</cite>. This behavior may differ from the expected behavior, where only the column <cite>name</cite> is displayed and can be customized independently.</li>
+<li>Add compatibility with sale_product_configurator module</li>
+<li>Add compatibility with purchase_product_matrix module</li>
+<li>When this module is installed, the PDF report will always display the
+column name as a combination of the product code, product name, and
+description. This behavior may differ from the expected behavior,
+where only the column name is displayed and can be customized
+independently.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
 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
-<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_widget_product_label_section_and_note%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_widget_product_label_section_and_note%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -451,7 +459,7 @@ <h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_widget_product_label_section_and_note">OCA/web</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/17.0/web_widget_product_label_section_and_note">OCA/web</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>