docs: Correct instruction to run (ESPTOOL-1003)

[akym]

Previous command python esptool.py would only work if the repo is cloned, with instruction above in the documentation to install the pip package, it makes more sense to invoke the module and run the tool as follows.

python -m esptool -p PORT flash_id

This change fixes the following bug(s):

Make instructions clearer and easier to understand.

I have tested this change with the following hardware & software combinations:

NO TESTING

I have run the esptool.py automated integration tests with this change and the above hardware:

NO TESTING

[github-actions]

Warnings

⚠️

Some issues found for the commit messages in this PR: the commit message "docs: Correct instruction to run ": body's lines must not be longer than 100 characters Please fix these commit messages - here are some basic tips: follow Conventional Commits style correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello akym, we appreciate your contribution to this project!

---

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

---

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against dc1516a

[radimkarnis]

Hi @akym,
thanks for the contribution!

Previous command python esptool.py would only work if the repo is cloned

1. That's true, if the repo was cloned and esptool is invoked from the sources without installation, python esptool.py <cmd> would be the way (targeting this wrapper file). But the command in docs does not have the python part - there is a difference between python esptool.py <cmd> and esptool.py <cmd>.
2. The docs mention the command simply as esptool.py <cmd> (without python), which is what you can do when installing with pip. It creates an alias during installation allowing you to run the tool without having to invoke it as a module (python -m ...)

Although the changes you propose would work as well, I don't believe they make things clearer and easier to understand for basic users (or people inexperienced with Python). The quick start guide should be as simple as possible. I am sorry, but for these reasons, I have to close this PR.