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

DOC Remove filterwarnings from some examples #766

Closed
2 tasks done
Vincent-Maladiere opened this issue Sep 29, 2023 · 10 comments
Closed
2 tasks done

DOC Remove filterwarnings from some examples #766

Vincent-Maladiere opened this issue Sep 29, 2023 · 10 comments
Labels
documentation Add or improve the documentation good first issue Good for newcomers meta-issue Lists a bunch of tasks no changelog needed

Comments

@Vincent-Maladiere
Copy link
Member

Vincent-Maladiere commented Sep 29, 2023

Describe the issue linked to the documentation

Some examples filter all warnings, but we want those for debugging, catching deprecation, and getting closer to the user reality.

We need to remove warnings.filterwarnings("ignore") —and fix the potential warnings— from the following files:

  • 03_datetime_encoder.py
  • 04_fuzzy_joining.py

Suggest a potential alternative/fix

No response

@Vincent-Maladiere Vincent-Maladiere added documentation Add or improve the documentation meta-issue Lists a bunch of tasks no changelog needed labels Sep 29, 2023
@Vincent-Maladiere Vincent-Maladiere changed the title ENH Remove filterwarnings from some examples DOC Remove filterwarnings from some examples Sep 29, 2023
@Vincent-Maladiere Vincent-Maladiere added the good first issue Good for newcomers label Sep 29, 2023
@Tialo
Copy link
Contributor

Tialo commented Sep 29, 2023

https://github.com/skrub-data/skrub/blob/main/skrub/_fuzzy_join.py#L359

If it warns whenever used, probably it's bad idea to remove filterwarnings.

@Tialo
Copy link
Contributor

Tialo commented Sep 29, 2023

There is also warning in https://skrub-data.org/stable/auto_examples/02_investigating_dirty_categories.html

I can fix it if necessary.

@Vincent-Maladiere
Copy link
Member Author

main/skrub/_fuzzy_join.py#L359

If it warns whenever used, probably it's bad idea to remove filterwarnings.

Indeed, we plan to remove warnings.warn("This feature is still experimental.") since the entire package is experimental.

@Vincent-Maladiere
Copy link
Member Author

There is also warning in skrub-data.org/stable/auto_examples/02_investigating_dirty_categories.html

I can fix it if necessary.

That would be great, you can go ahead and create a PR!

@dcor01
Copy link
Contributor

dcor01 commented Oct 18, 2023

Hi guys, I'm hoping to try and fix these warnings in example 3 and 4

@Vincent-Maladiere
Copy link
Member Author

Hey @dcor01, example 3 is already solved, but you can focus on example 4.

@dcor01
Copy link
Contributor

dcor01 commented Oct 26, 2023

I have made a pull request let me know your thoughts. #807

I also made a few capitalisation changes in example 4.

@dcor01
Copy link
Contributor

dcor01 commented Oct 28, 2023

Changed the filter warnings in example 4 in #808

1 similar comment
@dcor01
Copy link
Contributor

dcor01 commented Oct 28, 2023

Changed the filter warnings in example 4 in #808

@Vincent-Maladiere
Copy link
Member Author

Thank you @dcor01 and @Tialo, closing the issue :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or improve the documentation good first issue Good for newcomers meta-issue Lists a bunch of tasks no changelog needed
Projects
None yet
Development

No branches or pull requests

3 participants