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

Correct click.edit typing #2804

Merged
merged 2 commits into from
Dec 22, 2024
Merged

Correct click.edit typing #2804

merged 2 commits into from
Dec 22, 2024

Conversation

AndreasBackx
Copy link
Collaborator

@AndreasBackx AndreasBackx commented Nov 9, 2024

The following typing issues existed before:

  • click.edit
    1. The text argument accepted bytearray but was not included in the typing.
  • _termui_impl
    1. If None was inputted, str would be returned but typing suggested that it would be str if str was given and bytes if bytes was given.

This resolved an type: ignore as well.

  • Add tests that demonstrate the correct behavior of the change. Tests
    should fail without the change.
  • Add or update relevant docs, in the docs folder and in code.
  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
    • Not going to add an entry because bytearray was always accepted, just not documented.
  • Add .. versionchanged:: entries in any relevant code docs.

@AndreasBackx AndreasBackx force-pushed the typing/edit branch 2 times, most recently from 4f66560 to 9d7bb69 Compare November 9, 2024 17:09
@AndreasBackx AndreasBackx marked this pull request as ready for review November 9, 2024 17:15
@AndreasBackx AndreasBackx merged commit 4ffa1ef into main Dec 22, 2024
12 checks passed
@AndreasBackx AndreasBackx deleted the typing/edit branch December 22, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant