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

typecheck docs/conf.py #12697

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Conversation

danieleades
Copy link
Contributor

No description provided.

doc/conf.py Show resolved Hide resolved
sphinx/application.py Outdated Show resolved Hide resolved
sphinx/util/docfields.py Outdated Show resolved Hide resolved
sphinx/util/docfields.py Outdated Show resolved Hide resolved
@@ -177,7 +177,7 @@ def merge_members_option(options: dict) -> None:

# Some useful event listener factories for autodoc-process-docstring.

def cut_lines(pre: int, post: int = 0, what: str | None = None) -> Callable:
def cut_lines(pre: int, post: int = 0, what: str | list[str] | None = None) -> Callable:
Copy link
Member

Choose a reason for hiding this comment

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

You should also update the signature of between below since they are hooks for the same event (but you can also do it in a follow-up PR since it's not directly tight to docs/conf.py itself).

@picnixz
Copy link
Member

picnixz commented Aug 26, 2024

Good for me! you can do the follow-up PR on between if you want by the way.

@picnixz picnixz merged commit 53f8edf into sphinx-doc:master Aug 26, 2024
22 checks passed
@AA-Turner
Copy link
Member

@picnixz I think the merge may have been slightly premature here -- the force push removed several changes, such as ensuring imports were in type checking block.

More minor, but also can we ensure that commit messages start with an imperative (eg Check doc/conf.py with mypy or etc).

A

@picnixz
Copy link
Member

picnixz commented Aug 26, 2024

the force push removed several changes, such as ensuring imports were in type checking block.

Ah, actually, you marked the conversation as being resolved, so I assumed you wanted to keep it out (is it what you were thinking about)? We can revert the commit if needed though and amend the PR.

More minor, but also can we ensure that commit messages start with an imperative

Ah yes, this is something I wondered. I used for a long time [lint] message but I remembered a comment where you wanted to avoid the [...] and instead use topic: .... So, in the future, you would prefer always an imperative style in the commit title or do you want an imperative style in the commit description

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.

4 participants