Skip to content

Remove section on incomplete/partial stubs from CONTRIBUTING.md #8962

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

Closed
ramvikrams wants to merge 2 commits into from
Closed

Remove section on incomplete/partial stubs from CONTRIBUTING.md #8962

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
730c7f8
change in contributing.md
ramvikrams Oct 21, 2022
97888ca
updating
ramvikrams Oct 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 1 addition & 27 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,37 +342,11 @@ always put the code for the most recent Python version first.

### Incomplete stubs

We accept partial stubs, especially for larger packages. These need to
follow the following guidelines:
We generally prefer complete stubs, but for larger packages can be submitted with some incomplete non-essential parts.The thing to be remembered is:

* Included functions and methods must list all arguments, but the arguments
can be left unannotated. Do not use `Any` to mark unannotated arguments
or return values.
* Partial classes must include a `__getattr__()` method marked with an
`# incomplete` comment (see example below).
* Partial modules (i.e. modules that are missing some or all classes,
functions, or attributes) must include a top-level `__getattr__()`
function marked with an `Incomplete` return type (see example below).
* Partial packages (i.e. packages that are missing one or more sub-modules)
must have a `__init__.pyi` stub that is marked as incomplete (see above).
A better alternative is to create empty stubs for all sub-modules and
mark them as incomplete individually.

Example of a partial module with a partial class `Foo` and a partially
annotated function `bar()`:

```python
from _typeshed import Incomplete

class Foo:
def __getattr__(self, name: str) -> Incomplete: ...
x: int
y: str

def bar(x: str, y, *, z=...): ...

def __getattr__(name: str) -> Incomplete: ...
```

## Stub file coding style

Expand Down