Skip to content

Build the docs in CI for all PRs touching the mypy/ directory#16068

Merged
hauntsaninja merged 5 commits intopython:masterfrom
AlexWaygood:patch-1
Sep 7, 2023
Merged

Build the docs in CI for all PRs touching the mypy/ directory#16068
hauntsaninja merged 5 commits intopython:masterfrom
AlexWaygood:patch-1

Conversation

@AlexWaygood
Copy link
Copy Markdown
Member

@AlexWaygood AlexWaygood commented Sep 7, 2023

  1. Introduce error category [unsafe-overload] #16061 added a new error code, but didn't add any docs for the new error code
  2. Because nothing in the docs/ directory was modified, the docs CI job didn't run on that PR
  3. Now the docs build is failing on master because we have an error code without any documentation: https://github.com/python/mypy/actions/runs/6112378542/job/16589719563

- python#16061 added a new error code, but didn't add any docs for the new error code
- Because nothing in the `docs/` directory was modified, the docs CI job didn't run on that PR
- Now the docs build is failing on `master` because we have an error code without any documentation: https://github.com/python/mypy/actions/runs/6112378542/job/16589719563
Comment thread .github/workflows/docs.yml Outdated
@github-actions

This comment has been minimized.

Copy link
Copy Markdown
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

Thanks for fixing! If we wanted to, we could scope to just mypy/errorcodes.py

@AlexWaygood
Copy link
Copy Markdown
Member Author

AlexWaygood commented Sep 7, 2023

Thanks for fixing! If we wanted to, we could scope to just mypy/errorcodes.py

That maybe opens up a small risk of e.g. what if we refactored things in the future and put the error codes somewhere else... but yeah, that seems unlikely! I'll make the change

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 7, 2023

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

Copy link
Copy Markdown
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

Thanks!

@hauntsaninja hauntsaninja merged commit 816ba3b into python:master Sep 7, 2023
@AlexWaygood AlexWaygood deleted the patch-1 branch September 7, 2023 20:24
hauntsaninja added a commit to hauntsaninja/mypy that referenced this pull request Sep 9, 2023
A new error code was introduced in
python#16061

As per python#16068, we didn't previously
run doc builds on changes to errorcodes.py, causing tests to fail on
master when this was merged.

Renaming the code as per:
python#16061 (comment)
All type ignores should be unsafe, so we should save the unsafe
adjective for things that are really unsafe. As it stands, there are
many cases where overloads overlap somewhat benignly.
hauntsaninja added a commit that referenced this pull request Sep 10, 2023
A new error code was introduced in
#16061

As per #16068, we didn't previously
run doc builds on changes to errorcodes.py, causing tests to fail on
master when this was merged.

Renaming the code as per:
#16061 (comment) All
type ignores should be unsafe, so we should save the unsafe adjective
for things that are really unsafe. As it stands, there are many cases
where overloads overlap somewhat benignly.

Fixes #8656
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 this pull request may close these issues.

3 participants