Skip to content

gh-119786: Move garbage collection doc from devguide to InternalDocs - #125282

Merged
iritkatriel merged 6 commits into
python:mainfrom
iritkatriel:gc-doc
Oct 11, 2024
Merged

gh-119786: Move garbage collection doc from devguide to InternalDocs#125282
iritkatriel merged 6 commits into
python:mainfrom
iritkatriel:gc-doc

Conversation

@iritkatriel

@iritkatrieliritkatriel commented Oct 10, 2024•
edited
Loading

Copy link
Copy Markdown
Member

Co-Authored-By: Adam Turner 9087854+aa-turner@users.noreply.github.com
Co-Authored-By: Carol Willing carolcode@willingconsulting.com
Co-Authored-By: Ezio Melotti ezio.melotti@gmail.com
Co-Authored-By: Hugo van Kemenade hugovk@users.noreply.github.com
Co-Authored-By: Itamar Ostricher itamarost@gmail.com
Co-Authored-By: Jesús Cea jcea@jcea.es
Co-Authored-By: Joannah Nanjekye 33177550+nanjekyejoannah@users.noreply.github.com
Co-Authored-By: Ned Batchelder ned@nedbatchelder.com
Co-Authored-By: Pablo Galindo Salgado Pablogsal@gmail.com
Co-Authored-By: Pamela Fox pamela.fox@gmail.com
Co-Authored-By: Sam Gross colesbury@gmail.com
Co-Authored-By: Stefan Pochmann 609905+pochmann@users.noreply.github.com
Co-Authored-By: T. Wouters thomas@python.org
Co-Authored-By: q-ata 24601033+q-ata@users.noreply.github.com
Co-Authored-By: slateny 46876382+slateny@users.noreply.github.com
Co-Authored-By: Борис Верховский boris.verk@gmail.com

@iritkatriel
iritkatriel marked this pull request as draft October 10, 2024 21:20
@bedevere-appbedevere-appBot mentioned this pull request Oct 10, 2024
Closed
@iritkatrieliritkatriel added docs Documentation in the Doc dir skip news labels Oct 10, 2024
@iritkatriel
iritkatriel marked this pull request as ready for review October 10, 2024 23:12
@iritkatrieliritkatriel mentioned this pull request Oct 10, 2024
Merged
@JacobCoffee

JacobCoffee commented Oct 10, 2024

Copy link
Copy Markdown
Member

Rendered doc: https://github.com/iritkatriel/cpython/blob/gc-doc/InternalDocs/garbage_collector.md
Old guide: https://devguide.python.org/internals/garbage-collector/

JacobCoffee
JacobCoffee reviewed Oct 10, 2024
View reviewed changes
Comment threadInternalDocs/garbage_collector.md Outdated
Comment threadInternalDocs/garbage_collector.md Outdated
Comment threadInternalDocs/garbage_collector.md
Comment threadInternalDocs/garbage_collector.md Outdated
variable ``A``, and one self-referencing object which is completely
unreachable:

```

@JacobCoffeeJacobCoffeeOct 10, 2024•
edited by AA-Turner
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
```
```pycon

@iritkatrieliritkatrielOct 11, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

What does this do? I don't notice a difference.

@JacobCoffeeJacobCoffeeOct 11, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

its supposed to do syntax highlighting, did it not work here? 😬

Comment threadInternalDocs/garbage_collector.md
Comment threadInternalDocs/garbage_collector.md Outdated
Comment threadInternalDocs/garbage_collector.md Outdated
Comment threadInternalDocs/garbage_collector.md Outdated
Comment threadInternalDocs/garbage_collector.md Outdated
AA-Turner
AA-Turner reviewed Oct 11, 2024
View reviewed changes
Comment threadInternalDocs/garbage_collector.md Outdated
Comment threadInternalDocs/garbage_collector.md Outdated
@JacobCoffee

JacobCoffee commented Oct 11, 2024

Copy link
Copy Markdown
Member

TIL pycon

@AA-Turner

AA-Turner commented Oct 11, 2024

Copy link
Copy Markdown
Member

There's also pytb. Though unhelpfully Sphinx uses Pygments and GitHub uses Linguist:

https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L5727-L5786

@iritkatriel@AA-Turner@JacobCoffee
Apply suggestions from code review
ea21be8
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
pablogsal
pablogsal approved these changes Oct 11, 2024
View reviewed changes

@pablogsalpablogsal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @iritkatriel ❤️

@iritkatriel
iritkatriel merged commit 89515be into python:mainOct 11, 2024
willingc
willingc approved these changes Oct 11, 2024
View reviewed changes

@willingcwillingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Small nit re: markdown style. It's more common to use single backticks to surround words to render as code. Typically, one would use double backticks only if there was a backtick in the code phrase.

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

Reviewers

@AA-TurnerAA-TurnerAA-Turner left review comments
@willingcwillingcwillingc approved these changes
@pablogsalpablogsalpablogsal approved these changes
@JacobCoffeeJacobCoffeeJacobCoffee approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@iritkatriel@JacobCoffee@AA-Turner@willingc@pablogsal