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.

Sign up for GitHub

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

Jump to bottom

[17.0][IMP] sale_order_type: improve readme #3336

Open
wants to merge 1 commit into
base: 17.0
Choose a base branch
from
Open

[17.0][IMP] sale_order_type: improve readme #3336

wants to merge 1 commit into from

Conversation

alicedsp
Copy link

Hello, here are some suggested modification concerning the readme part of the module.
Thanks

TumbaoJu
TumbaoJu suggested changes Oct 1, 2024
View reviewed changes
Copy link
Contributor

@TumbaoJu TumbaoJu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you rename the title of your PR :
[17.0][IMP] sale_order_type : improve Readme

@gurneyalex gurneyalex changed the title [IMP] sale_order_type/readme [17.0][IMP] sale_order_type: improve readme Oct 1, 2024
@gurneyalex
Copy link
Member

/ocabot merge patch

@OCA-git-bot
Copy link
Contributor

Hey, thanks for contributing! Proceeding to merge this for you.
Prepared branch 17.0-ocabot-merge-pr-3336-by-gurneyalex-bump-patch, awaiting test results.

OCA-git-bot added a commit that referenced this pull request Oct 1, 2024
@OCA-git-bot
Merge PR #3336 into 17.0
c0c62d1 
Signed-off-by gurneyalex
@OCA-git-bot
Copy link
Contributor

@gurneyalex The merge process could not be finalized, because command oca-gen-addon-readme --if-source-changed --org-name OCA --repo-name sale-workflow --branch 17.0 --addons-dir /tmp/tmpamk8ni5t --commit failed with output:

/tmp/tmpamk8ni5t/sale_order_type/README.rst:86: (ERROR/3) Duplicate substitution definition name: "alt text".
Traceback (most recent call last):
  File "/usr/local/bin/oca-gen-addon-readme", line 8, in <module>
    sys.exit(gen_addon_readme())
             ^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/click/core.py", line 1157, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/click/core.py", line 1078, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/click/core.py", line 1434, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/src/oca-maintainers-tools/tools/gen_addon_readme.py", line 575, in gen_addon_readme
    check_rst(readme_filename)
  File "/ocamt/src/oca-maintainers-tools/tools/gen_addon_readme.py", line 398, in check_rst
    publish_file(
  File "/ocamt/lib/python3.12/site-packages/docutils/core.py", line 422, in publish_file
    output, publisher = publish_programmatically(
                        ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/core.py", line 722, in publish_programmatically
    output = publisher.publish(enable_exit_status=enable_exit_status)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/core.py", line 234, in publish
    self.document = self.reader.read(self.source, self.parser,
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/readers/__init__.py", line 70, in read
    self.parse()
  File "/ocamt/lib/python3.12/site-packages/docutils/readers/__init__.py", line 76, in parse
    self.parser.parse(self.input, document)
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/__init__.py", line 184, in parse
    self.statemachine.run(inputlines, document, inliner=self.inliner)
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 169, in run
    results = StateMachineWS.run(self, input_lines, input_offset,
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/statemachine.py", line 233, in run
    context, next_state, result = self.check_line(
                                  ^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/statemachine.py", line 445, in check_line
    return method(match, context, next_state)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 3034, in text
    self.section(title.lstrip(), source, style, lineno + 1, messages)
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 325, in section
    self.new_subsection(title, lineno, messages)
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 391, in new_subsection
    newabsoffset = self.nested_parse(
                   ^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 279, in nested_parse
    state_machine.run(block, input_offset, memo=self.memo,
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 195, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/statemachine.py", line 233, in run
    context, next_state, result = self.check_line(
                                  ^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/statemachine.py", line 445, in check_line
    return method(match, context, next_state)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 2790, in underline
    self.section(title, source, style, lineno - 1, messages)
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 325, in section
    self.new_subsection(title, lineno, messages)
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 391, in new_subsection
    newabsoffset = self.nested_parse(
                   ^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 279, in nested_parse
    state_machine.run(block, input_offset, memo=self.memo,
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 195, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/statemachine.py", line 233, in run
    context, next_state, result = self.check_line(
                                  ^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/statemachine.py", line 445, in check_line
    return method(match, context, next_state)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 2357, in explicit_markup
    nodelist, blank_finish = self.explicit_construct(match)
                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 2369, in explicit_construct
    return method(self, expmatch)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 2087, in substitution_def
    self.document.note_substitution_def(
  File "/ocamt/lib/python3.12/site-packages/docutils/nodes.py", line 1536, in note_substitution_def
    msg = self.reporter.error(
          ^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/utils/__init__.py", line 231, in error
    return self.system_message(self.ERROR_LEVEL, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ocamt/lib/python3.12/site-packages/docutils/utils/__init__.py", line 197, in system_message
    raise SystemMessage(msg, level)
docutils.utils.SystemMessage: /tmp/tmpamk8ni5t/sale_order_type/README.rst:86: (ERROR/3) Duplicate substitution definition name: "alt text".

gurneyalex
gurneyalex reviewed Oct 1, 2024
View reviewed changes
Copy link
Member

@gurneyalex gurneyalex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some suggestion to fix an error about duplicated alt text tags.

sale_order_type/readme/CONFIGURE.md
@@ -1,4 +1,12 @@
To configure Sale Order Types you need to:

1. Go to **Sales \> Configuration \> Sales Orders Types**
2. Create a new sale order type with all the settings you want

![alt text](../static/description/Sale_type_confi_1.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![alt text](../static/description/Sale_type_confi_1.png)
![Sale type configuration](../static/description/Sale_type_confi_1.png)

sale_order_type/readme/CONFIGURE.md
![alt text](../static/description/Sale_type_confi_1.png)

2. The list of already existing "types" will be displayed
![alt text](../static/description/Sale_type_config_2.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![alt text](../static/description/Sale_type_config_2.png)
![List of sale types](../static/description/Sale_type_config_2.png)

sale_order_type/readme/CONFIGURE.md

3. Create a new Sale Order type with all the settings you want using the available fields:

![Alt text](../static/description/Sale_type_config_3.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![Alt text](../static/description/Sale_type_config_3.png)
![Sale type creation](../static/description/Sale_type_config_3.png)

sale_order_type/readme/USAGE.md
@@ -1,5 +1,13 @@
1. Go to **Sales \> Sales Orders** and create a new sale order. Select
the new type you have created before and all settings will be
propagated.

![alt text](../static/description/Sale_type_usage_1.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![alt text](../static/description/Sale_type_usage_1.png)
![Sale type usage](../static/description/Sale_type_usage_1.png)

sale_order_type/readme/USAGE.md
*Sales & Purchases* and set a sale order type.
*Sales & Purchases* tab of the partner and set a sale order type:

![alt text](../static/description/Sale_type_usage_2.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![alt text](../static/description/Sale_type_usage_2.png)
![Sale type for a partner](../static/description/Sale_type_usage_2.png)

sale_order_type/readme/USAGE.md
![alt text](../static/description/Sale_type_usage_2.png)

Scroll down to find the "Sale order Type" field:
![alt text](../static/description/Sale_type_usage_3.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![alt text](../static/description/Sale_type_usage_3.png)
![Setting the sale type on a partner](../static/description/Sale_type_usage_3.png)

@rousseldenis
Copy link
Contributor

@alicedsp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gurneyalex gurneyalex gurneyalex approved these changes

@TumbaoJu TumbaoJu TumbaoJu requested changes

@lfreeke lfreeke lfreeke approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@alicedsp @gurneyalex @OCA-git-bot @rousseldenis @lfreeke @TumbaoJu