Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove partial classes/modules from CONTRIBUTING? #8955

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
Closed
srittau opened this issue Oct 21, 2022 · 2 comments · Fixed by #9548
Closed

Remove partial classes/modules from CONTRIBUTING? #8955

srittau opened this issue Oct 21, 2022 · 2 comments · Fixed by #9548
Labels
project: infrastructure typeshed build, test, documentation, or distribution related project: policy Organization of the typeshed project

Comments

@srittau
Copy link
Collaborator

srittau commented Oct 21, 2022

We still have a section about "Incomplete stubs" in CONTRIBUTING. I believe we should remove this as nowadays stubs are generally generated using stubgen, so this shouldn't be an issue anymore. I don't want to encourage new incomplete stubs, and it makes the CONTRIBUTING file a longer read.

We only should leave the sentence about unannotated arguments and return values.
@srittau srittau added the project: policy Organization of the typeshed project label Oct 21, 2022
@ramvikrams ramvikrams mentioned this issue Oct 21, 2022
Closed
@ramvikrams
Copy link

Done with the changes

@AlexWaygood AlexWaygood linked a pull request Nov 10, 2022 that will close this issue
Remove section on incomplete/partial stubs from CONTRIBUTING.md #8962
Closed
@Avasam
Copy link
Collaborator

Avasam commented Nov 12, 2022 •
edited
Loading

With this, should ignore_missing_stub default to false? Since "we don't want to encourage new incomplete stubs". It's mainly needed for stubs that are already present and incomplete, or would result in an allowlist that's too complex. (the create_baseline_stubs script does set it to false, I'm thinking about running stubtest with it false by default)

@Avasam Avasam mentioned this issue Jan 14, 2023
Closed
srittau added a commit to srittau/typeshed that referenced this issue Jan 16, 2023
@srittau
Rework the "Incomplete stubs" section
a730e2f 
Also move it to the "Conventions" section due its scope change.

Closes: python#8955
@srittau srittau mentioned this issue Jan 16, 2023
Merged
srittau added a commit that referenced this issue Feb 3, 2023
@srittau
Rework the "Incomplete stubs" section (#9548)
cd64563 
Also move it to the "Conventions" section due its scope change.

Closes: #8955
@srittau srittau added project: infrastructure typeshed build, test, documentation, or distribution related and removed docs labels Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
project: infrastructure typeshed build, test, documentation, or distribution related project: policy Organization of the typeshed project
Projects
None yet
Milestone
No milestone
4 participants
@srittau @Avasam @AlexWaygood @ramvikrams