doc: Add "Attaching a Debugger" section to README #570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lgarber-akamai
added
the
documentation
lgarber-akamai
requested review from
jriddle-linode and
zliang-akamai
and removed request for
a team
lgarber-akamai
commented
Aug 20, 2024
| @@ -102,6 +102,31 @@ For more information on Ansible collection usage, see [Ansible's official usage | |||
|
|
|||
| Use-case examples for this collection can be found [here](./examples/README.md). | |||
|
|
|||
| ## Development | |||
There was a problem hiding this comment.
Unless anyone has any objections, I plan on making a ticket to flesh this section out when I have time 🙂
zliang-akamai
approved these changes
Aug 20, 2024
| ### Attaching a Debugger | ||
|
|
||
| To quickly and easily attach a debugger to a running module in this collection, | ||
| you can use the [madbg](https://pypi.org/project/madbg/) package: |
There was a problem hiding this comment.
Is there any alternative debuggers? The development of the madbg repository doesn't seem to be active..
There was a problem hiding this comment.
The Ansible-recommended debugger is epdb but it doesn't seem to work with Ansible's stdout weirdness anymore, and isn't being too actively maintained either. It'd definitely be worth looking into other projects though 👀
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
This pull request adds a small "Attaching a Debugger" section to this project's README.
✔️ How to Test
N/A