Skip to content

typecheck docs/conf.py#12697

Merged
picnixz merged 1 commit intosphinx-doc:masterfrom
danieleades:typecheck-conf.py
Aug 26, 2024
Merged

typecheck docs/conf.py#12697
picnixz merged 1 commit intosphinx-doc:masterfrom
danieleades:typecheck-conf.py

Conversation

@danieleades
Copy link
Copy Markdown
Contributor

No description provided.

@danieleades danieleades requested a review from chrisjsewell July 27, 2024 16:52
# 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
Copy Markdown
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
Copy Markdown
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
@AA-Turner
Copy link
Copy Markdown
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
Copy Markdown
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

AA-Turner added a commit to AA-Turner/sphinx that referenced this pull request Oct 1, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 2, 2024
@AA-Turner AA-Turner added this to the 8.1.x milestone Oct 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants