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

scripts/create_baseline_stubs.py instructions are outdated #8837

Closed
Akuli opened this issue Oct 4, 2022 · 3 comments · Fixed by #8843
Closed

scripts/create_baseline_stubs.py instructions are outdated #8837

Akuli opened this issue Oct 4, 2022 · 3 comments · Fixed by #8843

Comments

@Akuli
Copy link
Collaborator

Akuli commented Oct 4, 2022

I would prefer:

1. Manually review the generated stubs in {stub_dir}
2. Run tests locally if you want (see CONTRIBUTING.md)
3. Commit the changes on a new branch and create a typeshed PR

The CI will check everything anyway, and is set up so that you don't have to run anything locally. This would also be consistent with CONTRIBUTING.md.

Originally posted by @Akuli in #8686 (comment)

@srittau
Copy link
Collaborator

srittau commented Oct 4, 2022

One problem with the generated stubs were overzealous re-exports. Is this still an issue? In that case we should probably mention it. But +1 from me.

@AlexWaygood
Copy link
Member

AlexWaygood commented Oct 4, 2022

@Avasam has a proposed fix for this included as part of #8798 (edit: now merged).

@AlexWaygood
Copy link
Member

One problem with the generated stubs were overzealous re-exports. Is this still an issue? In that case we should probably mention it. But +1 from me.

This is definitely still an issue. But @hauntsaninja mentioned to me recently that this can probably be fixed just by passing the --export-less argument to stubgen. We should see if that fixes the problem — if so, there's no need to mention it to contributors in the create_baseline_stubs.py instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants