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

Ensure changeset.descname is a string when not None #13150

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Nov 22, 2024

Feature or Bugfix

  • Refactoring

Purpose

ChangeSet defines the type of descname as str | None. Currently, it is actually ObjDescT | None, which can be str | tuple[str, str] | ASTDeclaration | None. We only use descname in ChangesBuilder.write_documents() where we coerce it to a string, so this PR converts to a string earlier to ensure type safety.

A

@AA-Turner AA-Turner merged commit ddd5aed into sphinx-doc:master Nov 22, 2024
23 checks passed
@AA-Turner AA-Turner deleted the cleanup/changes-descname branch November 22, 2024 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant