Skip to content

TYP: loosen types of to_markdown, align to docs #46212

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
Merged
merged 1 commit into from
Mar 3, 2022
Merged

TYP: loosen types of to_markdown, align to docs #46212

merged 1 commit into from
Mar 3, 2022

Conversation

alexpovel
Copy link
Contributor

Docs already allowed pathlib.Path objects and such
code runs, but failed mypy typechecks. This fixes it.

@alexpovel
Copy link
Contributor Author

alexpovel commented Mar 3, 2022 •
edited
Loading

As for code checks, I only ran the typing tests (from the provided container config in .devcontainer.json):

$ ./ci/code_checks.sh typing
mypy --version
mypy 0.931
Performing static analysis using mypy
Success: no issues found in 1363 source files
Performing static analysis using mypy DONE

Please let me know if an entry to the vX.X.X.rst file should be made (and which version). This change doesn't feel worth mentioning though.

twoertwein
twoertwein reviewed Mar 3, 2022
View reviewed changes
@alexpovel
TYP: loosen types of to_markdown, align to docs
2c35bae 
Docs already allowed pathlib.Path objects and such
code runs, but failed mypy typechecks. This fixes it.
twoertwein
twoertwein approved these changes Mar 3, 2022
View reviewed changes
Copy link
Member

@twoertwein twoertwein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alexpovel, looks good to me!

@jreback jreback added this to the 1.5 milestone Mar 3, 2022
@jreback jreback added the Typing type annotations, mypy/pyright type checking label Mar 3, 2022
@jreback jreback merged commit 4e3826f into pandas-dev:main Mar 3, 2022
@jreback
Copy link
Contributor

jreback commented Mar 3, 2022

thanks @alexpovel

yehoshuadimarsky pushed a commit to yehoshuadimarsky/pandas that referenced this pull request Jul 13, 2022
@alexpovel @yehoshuadimarsky
TYP: loosen types of to_markdown, align to docs (pandas-dev#46212)
404e518
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@twoertwein twoertwein twoertwein approved these changes

Assignees
No one assigned
Labels
Typing type annotations, mypy/pyright type checking
Projects
None yet
Milestone
1.5
Development

Successfully merging this pull request may close these issues.

TYP: to_markdown fails mypy check if using pathlib.Path
3 participants
@alexpovel @jreback @twoertwein