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

Merge the specification portion of the "Type Stubs" doc into the spec #1815

Merged
merged 46 commits into from
Aug 21, 2024

Commits on Jul 21, 2024

  1. Type Stubs: move intro and syntax to spec.

    * Moves some content into spec, deletes duplicate spec content.
    * Adds placeholders for where remaining content will be moved. It will be
      split between the spec and the writing_stubs doc.
    rchen152 committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    7f260c8 View commit details
    Browse the repository at this point in the history
  2. Move "Stub Contents" to writing_stubs.

    Moves the section on what to include in stubs with editorial changes only -
    e.g., changing "type stub" to "stub file" to match surrounding terminology.
    rchen152 committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    1d29334 View commit details
    Browse the repository at this point in the history
  3. Moves "Style Guide" to writing_stubs doc.

    Moves the style guide with a few updates:
    * Editorial changes like tweaking code examples to use recommended style.
    * Attribute declarations can use assignments when needed to convey extra
      information - e.g., final attributes and enum members.
    * Tweaks a reference to the double-underscore convention for positional-only
      arguments to note that it's historical.
    rchen152 committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    065c3d3 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    d283c38 View commit details
    Browse the repository at this point in the history
  5. Move a few "Supported Constructs" sections into spec.

    The only substantive change is an update to "Comments" to note that many
    formats of error suppression comments are allowed.
    rchen152 committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    01b34ca View commit details
    Browse the repository at this point in the history
  6. Migrated "Imports" and "Module Level Attributes" supported constructs.

    Added `x: Final = <literal>` to module-level attributes section.
    No other changes.
    rchen152 committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    be35ffe View commit details
    Browse the repository at this point in the history
  7. Migrate "Enums" supported construct section.

    Replaces outdated info with a link to the enums section of the spec.
    rchen152 committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    00766db View commit details
    Browse the repository at this point in the history

Commits on Jul 22, 2024

  1. Move "Classes" and "Decorators" supported constructs sections.

    Added an example of an inner class to "Classes." Removed mention of
    asyncio.coroutine from "Decorators" as it's very deprecated. Added functions
    decorated with `@dataclass_transform` to list of decorators that type
    checkers should recognize.
    rchen152 committed Jul 22, 2024
    Configuration menu
    Copy the full SHA
    c524da4 View commit details
    Browse the repository at this point in the history
  2. Port "Functions and Methods" supported constructs section.

    Removed mention of individual supported/unsupported features from this
    section. Where we state that all typing features from the latest released
    version are supported, added a caveat with a link to the typeshed feature
    tracker.
    rchen152 committed Jul 22, 2024
    Configuration menu
    Copy the full SHA
    abd198f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    e0b16d9 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    b3e9b9c View commit details
    Browse the repository at this point in the history
  5. Fix broken refs.

    rchen152 committed Jul 22, 2024
    Configuration menu
    Copy the full SHA
    31c52c0 View commit details
    Browse the repository at this point in the history

Commits on Jul 23, 2024

  1. Formatting fix to docs/guides/writing_stubs.rst

    Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
    rchen152 and srittau committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    90170aa View commit details
    Browse the repository at this point in the history
  2. Reword paragraph on argument names to be more concise.

    Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
    rchen152 and srittau committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    e9d3211 View commit details
    Browse the repository at this point in the history
  3. Wording clarification in docs/guides/writing_stubs.rst

    Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
    rchen152 and srittau committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    4c7fee2 View commit details
    Browse the repository at this point in the history
  4. Modernize code example in docs/guides/writing_stubs.rst

    Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
    rchen152 and srittau committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    60d80d8 View commit details
    Browse the repository at this point in the history
  5. Typo fix in docs/spec/distributing.rst

    Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
    rchen152 and srittau committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    a2a9d72 View commit details
    Browse the repository at this point in the history
  6. Typo fix in docs/spec/distributing.rst

    Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
    rchen152 and srittau committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    0c3bd2c View commit details
    Browse the repository at this point in the history
  7. Grammar fixes

    rchen152 committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    da4571e View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    1e609fe View commit details
    Browse the repository at this point in the history

Commits on Jul 24, 2024

  1. Address future notes.

    rchen152 committed Jul 24, 2024
    Configuration menu
    Copy the full SHA
    05434ed View commit details
    Browse the repository at this point in the history
  2. Fix silly formatting error.

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

Commits on Jul 26, 2024

  1. Configuration menu
    Copy the full SHA
    2a927e6 View commit details
    Browse the repository at this point in the history

Commits on Jul 27, 2024

  1. Undelete stubs.rst.

    rchen152 committed Jul 27, 2024
    Configuration menu
    Copy the full SHA
    10cb969 View commit details
    Browse the repository at this point in the history

Commits on Jul 29, 2024

  1. Configuration menu
    Copy the full SHA
    026f2a1 View commit details
    Browse the repository at this point in the history
  2. Address review comments.

    * Reword some sections to focus on type checker behavior.
    * Move or remove some sections that fit better in the writing_stubs guide or
      are redundant.
    rchen152 committed Jul 29, 2024
    Configuration menu
    Copy the full SHA
    46e133f View commit details
    Browse the repository at this point in the history

Commits on Jul 30, 2024

  1. Address more review comments.

    Cuts redundant sections, moves things to writing_stubs, tries out a new
    "these should be supported fully" and "these should be supported to at least
    the described minimum" structure.
    rchen152 committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    8a9eda8 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    14966d2 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1ab8a33 View commit details
    Browse the repository at this point in the history

Commits on Jul 31, 2024

  1. Configuration menu
    Copy the full SHA
    df94e57 View commit details
    Browse the repository at this point in the history
  2. Address more reviewer comments.

    Moves "Library Interface" into spec, further trims redundant text.
    rchen152 committed Jul 31, 2024
    Configuration menu
    Copy the full SHA
    93ce31d View commit details
    Browse the repository at this point in the history
  3. Remove extra colon.

    rchen152 committed Jul 31, 2024
    Configuration menu
    Copy the full SHA
    61dafc4 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    fe4c850 View commit details
    Browse the repository at this point in the history

Commits on Aug 1, 2024

  1. Configuration menu
    Copy the full SHA
    99df017 View commit details
    Browse the repository at this point in the history
  2. Delete unnecessary sentence.

    Co-authored-by: Carl Meyer <carl@oddbird.net>
    rchen152 and carljm committed Aug 1, 2024
    Configuration menu
    Copy the full SHA
    7bf4ce5 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    6bbcff7 View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2024

  1. Configuration menu
    Copy the full SHA
    15adb5b View commit details
    Browse the repository at this point in the history
  2. Address reviewer feedback.

    rchen152 committed Aug 9, 2024
    Configuration menu
    Copy the full SHA
    98a72e7 View commit details
    Browse the repository at this point in the history
  3. Formatting

    rchen152 committed Aug 9, 2024
    Configuration menu
    Copy the full SHA
    a448b4a View commit details
    Browse the repository at this point in the history
  4. Drop "annotation contexts."

    rchen152 committed Aug 9, 2024
    Configuration menu
    Copy the full SHA
    eaaade2 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    f270102 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    8d18706 View commit details
    Browse the repository at this point in the history

Commits on Aug 13, 2024

  1. Update docs/spec/distributing.rst

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

Commits on Aug 15, 2024

  1. Reword syntax section.

    rchen152 committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    6f030ad View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2024

  1. Update docs/spec/distributing.rst

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