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

Upgrade all examples/*.toml to #94 (expected_errors) #96

Open
Carreau opened this issue Mar 9, 2022 · 0 comments
Open

Upgrade all examples/*.toml to #94 (expected_errors) #96

Carreau opened this issue Mar 9, 2022 · 0 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Carreau
Copy link
Member

Carreau commented Mar 9, 2022

#94 introduce the <module_name>.expected_errors, which has a mapping of error names to which object fail with those.

In particular this will allow us to track when some errors get fixed (in papyri or upstream).

Other files, use the exclude = [list of str] option, which is impractical as it does not tell us whether the failure are still happening or not.

For all files that have a lot of values in exclude, we should migrate to <module_name>.expected_errors:

  • make exclude and empty list.
  • set early_error to false.
  • Run papyri gen --dry-run: it will print a list of encountered errors at the end of the run
  • Update the config file with the values from the step before.

It's ok to keep a few items in exclude if there are issues, but please add comments in the toml file with the reasons and or open issues if necessary.

@Carreau Carreau added good first issue Good for newcomers help wanted Extra attention is needed labels Mar 9, 2022
@steff456 steff456 self-assigned this Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants