Skip to content

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

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

Merged
merged 6 commits into from
Oct 11, 2024

Conversation

iritkatriel
Copy link
Member

@iritkatriel iritkatriel commented Oct 10, 2024

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 ready for review October 10, 2024 23:12
@JacobCoffee
Copy link
Member

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

variable ``A``, and one self-referencing object which is completely
unreachable:

```
Copy link
Member

@JacobCoffee JacobCoffee Oct 10, 2024

Choose a reason for hiding this comment

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

Suggested change
```
```pycon

Copy link
Member Author

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.

Copy link
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? 😬

@JacobCoffee
Copy link
Member

TIL pycon

@AA-Turner
Copy link
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

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Copy link
Member

@pablogsal pablogsal left a comment

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:main Oct 11, 2024
34 checks passed
Copy link
Contributor

@willingc willingc left a comment

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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants