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

docs: Add a tutorial for pystack remote - deadlock example #179

Merged
merged 3 commits into from
Jul 23, 2024
Merged

docs: Add a tutorial for pystack remote - deadlock example #179

merged 3 commits into from
Jul 23, 2024

Conversation

manasomali
Copy link

Issue number of the reported bug or feature request: #53

Describe your changes
Add the first tutorial about how to use PyStack to profiling the deadlock problem.

Testing performed
No tests added.

Additional context
Made during pycon2024 sprint. First day.

@manasomali manasomali force-pushed the Add-a-tutorial-to-the-documentation branch from 215c10b to 3f01b75 Compare May 20, 2024 19:58
@manasomali
Copy link
Author

Sorry, fixing the lint.

@manasomali manasomali force-pushed the Add-a-tutorial-to-the-documentation branch 2 times, most recently from b7d8472 to 61848ed Compare May 20, 2024 20:43
sarahmonod
sarahmonod previously requested changes May 20, 2024
View reviewed changes
Copy link
Contributor

@sarahmonod sarahmonod left a comment

Choose a reason for hiding this comment

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

First of all, thanks for working on this! This is fantastic and a really helpful addition. I think there are a few things that can be improved though, that I have detailed below.

docs/tutorials/deadlock.py Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
docs/tutorials/deadlock.rst Outdated Show resolved Hide resolved
@manasomali manasomali force-pushed the Add-a-tutorial-to-the-documentation branch 2 times, most recently from 0ee4e77 to c7c1437 Compare May 21, 2024 01:59
@sarahmonod sarahmonod changed the base branch from main to tutorial May 21, 2024 15:54
@sarahmonod sarahmonod changed the title Add a tutorial to the documentation docs: Tutorial - deadlock example May 21, 2024
@sarahmonod sarahmonod changed the title docs: Tutorial - deadlock example docs: Add a tutorial for pystack remote - deadlock example May 21, 2024
@manasomali
Copy link
Author

@gusmonod I don't know how to solve the error from build docs step. 🙃

@manasomali manasomali force-pushed the Add-a-tutorial-to-the-documentation branch from daf3e1a to 36243c0 Compare May 22, 2024 01:24
@manasomali
Copy link
Author

PR updated, added a new section related to the use of --locals. Along with the recommended improvements in the deadlock.py script.

@manasomali manasomali force-pushed the Add-a-tutorial-to-the-documentation branch from dd13857 to 7b6b5a1 Compare May 22, 2024 01:32
@manasomali
Copy link
Author

The test_in_alpine step is failing, what is the solution for this issue? 🤔

@godlygeek
Copy link
Contributor

The test_in_alpine step is failing, what is the solution for this issue? 🤔

That's fixed by #185

I'll pick this PR up soon and move it forward.

Matheus Nascimento added 2 commits July 23, 2024 17:17
@godlygeek
makefile: Add docs-live target
2fe9891 
This enables faster iteration on documentation.

Signed-off-by: Matheus Nascimento <[email protected]>
@godlygeek
docs: Add a tutorial on debugging a deadlock
bb99d86 
Signed-off-by: Matheus Nascimento <[email protected]>
@godlygeek godlygeek force-pushed the Add-a-tutorial-to-the-documentation branch from 7928aef to 3874328 Compare July 23, 2024 21:20
@godlygeek godlygeek changed the base branch from tutorial to main July 23, 2024 21:21
@godlygeek godlygeek force-pushed the Add-a-tutorial-to-the-documentation branch from 3874328 to 7b47237 Compare July 23, 2024 21:23
@godlygeek godlygeek dismissed sarahmonod’s stale review July 23, 2024 21:25

All requested changes have been addressed

godlygeek
godlygeek approved these changes Jul 23, 2024
View reviewed changes
Copy link
Contributor

@godlygeek godlygeek left a comment

Choose a reason for hiding this comment

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

I'll pick this PR up soon and move it forward.

"soon" 😅

I've slightly tweaked some of the wording here and there, and dropped the requirements-tutorial.txt in favor of just doing a python3 -m pip install pystack, at least for now. Otherwise, this LGTM!

Thanks so much for the contribution, @manasomali!

@godlygeek godlygeek enabled auto-merge (rebase) July 23, 2024 21:29
@godlygeek godlygeek merged commit 0d084a9 into bloomberg:main Jul 23, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@godlygeek godlygeek godlygeek approved these changes

@sarahmonod sarahmonod sarahmonod left review comments

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

Successfully merging this pull request may close these issues.
3 participants
@manasomali @godlygeek @sarahmonod