Skip to content

Move the Argument Clinic docs to the devguide #107518

Closed
Closed
Move the Argument Clinic docs to the devguide#107518
Labels
docsDocumentation in the Doc dirtopic-argument-clinic

Description

@erlend-aasland
erlend-aasland
opened on Jul 31, 2023

See topic on Discourse and python/devguide#1148

Quoting from the linked topic:

Currently, the Argument Clinic docs live in the How-To section of docs.python.org:

https://docs.python.org/3/howto/clinic.html.

The devguide does not mention Argument Clinic at all (except in the experts section).

The clinic docs's primary audience are core developers and contributors, which is also the primary audience of the devguide. I'd like to suggest we move the clinic docs from docs.python.org to devguide.python.org.

So far, I've only received encouraging reactions, both on Discourse and on the core dev Discord.

TODO:

Linked PRs

Activity

  1. erlend-aasland
    added
    docsDocumentation in the Doc dir
    topic-argument-clinic
    on Jul 31, 2023

  2. erlend-aasland commented on Aug 2, 2023

    @erlend-aasland
    erlend-aasland
    on Aug 2, 2023
    ContributorAuthor

    Filtered out branch: https://github.com/erlend-aasland/devguide/tree/migrate-clinic-docs

    PR:

  3. erlend-aasland commented on Sep 26, 2023

    @erlend-aasland
    erlend-aasland
    on Sep 26, 2023
    ContributorAuthor

    Thanks to @AA-Turner, python/devguide#1160 has now landed!

  4. AA-Turner commented on Sep 26, 2023

    @AA-Turner
    AA-Turner
    on Sep 26, 2023
    Member

    And now rendered!

    A

  5. erlend-aasland commented on Sep 26, 2023

    @erlend-aasland
    erlend-aasland
    on Sep 26, 2023
    ContributorAuthor

    And now rendered!

    Wow, that was fast :) Next, we need to redirect the old docs to the devguide (if possible!).

  6. rhettinger commented on Oct 1, 2023

    @rhettinger
    rhettinger
    on Oct 1, 2023
    Contributor

    +1 for moving to the devguide.

  7. erlend-aasland
    added 2 commits that reference this issue on Oct 11, 2023

    GH-107518: Remove the Argument Clinic How-To (#109900)

    d1f7fae

    [3.12] pythonGH-107518: Remove the Argument Clinic How-To (python#109900

    af63736

  8. erlend-aasland commented on Oct 12, 2023

    @erlend-aasland
    erlend-aasland
    on Oct 12, 2023
    ContributorAuthor

    Backports to 3.12 and 3.11 are queued for automerging. Marking this as resolved. Thanks to everyone who has helped with this effort; highly appreciated.

  9. erlend-aasland
    closed this as completedon Oct 12, 2023
  10. erlend-aasland
    added 2 commits that reference this issue on Oct 12, 2023

    [3.12] GH-107518: Remove the Argument Clinic How-To (#109900) (#110760)

    e8d0419

    [3.11] GH-107518: Remove the Argument Clinic How-To (#109900) (#110761)

    5178fb0
  11. Glyphack
    added a commit that references this issue on Sep 2, 2024

    pythonGH-107518: Remove the Argument Clinic How-To (python#109900)

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirtopic-argument-clinic

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions