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

Move best practices out of "Type Stubs" doc into guide on writing stubs. #1817

Merged
merged 10 commits into from
Jul 26, 2024
Merged

Move best practices out of "Type Stubs" doc into guide on writing stubs. #1817

merged 10 commits into from
Jul 26, 2024

Commits on Jul 24, 2024

  1. Move best practices out of "Type Stubs" doc into guide on writing stubs. 

    This is part of an effort to integrate the standalone "Type Stubs" doc
into the rest of the typing documentation. See
python#1815 for more context.

For python#1605.
    @rchen152
    rchen152 committed Jul 24, 2024
    Configuration menu
    Copy the full SHA
    5ff14f1 View commit details
    Browse the repository at this point in the history

  2. Add missing label.

    @rchen152
    rchen152 committed Jul 24, 2024
    Configuration menu
    Copy the full SHA
    cfc7150 View commit details
    Browse the repository at this point in the history

  3. Another missing label.

    @rchen152
    rchen152 committed Jul 24, 2024
    Configuration menu
    Copy the full SHA
    1daad10 View commit details
    Browse the repository at this point in the history

Commits on Jul 25, 2024

  1. Improve suggested annotation. 

    Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    @rchen152 @JelleZijlstra
    rchen152 and JelleZijlstra committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    2e75d36 View commit details
    Browse the repository at this point in the history

  2. Fix Protocol name. 

    Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    @rchen152 @JelleZijlstra
    rchen152 and JelleZijlstra committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    f4e47f0 View commit details
    Browse the repository at this point in the history

  3. Consolidate advice on stub-only objects and make it more consistent.

    @rchen152
    rchen152 committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    eb91f7b View commit details
    Browse the repository at this point in the history

  4. Remove recommendation to add # incomplete comment. 

    Also fixes some silly wording.
    @rchen152
    rchen152 committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    7385a67 View commit details
    Browse the repository at this point in the history

  5. Grammar fix.

    @rchen152
    rchen152 committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    ca82277 View commit details
    Browse the repository at this point in the history

Commits on Jul 26, 2024

  1. Typo fix 

    Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    @rchen152 @JelleZijlstra
    rchen152 and JelleZijlstra committed Jul 26, 2024
    Configuration menu
    Copy the full SHA
    0221a12 View commit details
    Browse the repository at this point in the history

  2. Better example of when to include all possible elements in __all__ 

    Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    @rchen152 @JelleZijlstra
    rchen152 and JelleZijlstra committed Jul 26, 2024
    Configuration menu
    Copy the full SHA
    17cd909 View commit details
    Browse the repository at this point in the history