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.

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

Add testing and debugging guide page to docs #39

Merged
merged 5 commits into from
Jul 25, 2024
Merged

Conversation

andfoy
Copy link
Member

@andfoy andfoy commented Jul 17, 2024

This adds a documentation page that highlights some of the steps for how to go about testing free-threading Python for a library.

@ngoldbaum ngoldbaum self-requested a review July 17, 2024 17:18
@rgommers rgommers added the documentation Improvements or additions to documentation label Jul 18, 2024
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Thanks @andfoy! This looks like it covers a good amount of ground for testing/debugging.

The one thing that comes to mind as nice to add is a note on hitting static_assert inside CPython, and what that could mean. @ngoldbaum it looks like you're going to review this PR in more detail? If so, maybe you could add this point?

docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ngoldbaum ngoldbaum left a comment

Choose a reason for hiding this comment

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

Left some text suggestions and comments.

@rgommers agreed we need a section covering common error messages for google to index. If you don't mind I'll go ahead and add a FAQ section in a followup.

docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Show resolved Hide resolved
Copy link
Collaborator

@lysnikolaou lysnikolaou left a comment

Choose a reason for hiding this comment

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

Thanks @andfoy! Ralf and Nathan covered most of it, but I left a couple of comments as well.

docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Show resolved Hide resolved
@rgommers
Copy link
Member

@rgommers agreed we need a section covering common error messages for google to index. If you don't mind I'll go ahead and add a FAQ section in a followup.

SGTM!

andfoy and others added 3 commits July 22, 2024 11:23
Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Copy link
Collaborator

@ngoldbaum ngoldbaum left a comment

Choose a reason for hiding this comment

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

the updated text looks good!

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Very nice, thanks @andfoy! And thanks @ngoldbaum and @lysnikolaou for the reviews.

@rgommers rgommers merged commit 8d3b252 into main Jul 25, 2024
1 check passed
@rgommers rgommers deleted the add_debugging_guide branch July 25, 2024 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants