refactor: Small fixes to type annotations #470
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also for event type annotations - if, hypothetically, MkDocs started to support them.
pawamoy
reviewed
Jul 17, 2023
| role=heading.attrib["data-role"], | ||
| uri=f"{page}#{anchor}", # noqa: WPS441 | ||
| ) | ||
| if page: |
There was a problem hiding this comment.
@oprypin this condition prevents using cross-refs when rendering API docs in the top-level index page. Can you remember why you added it? I guess it was just for type correctness?
I tested without it, and the utilities computing relative URLs work fine when page == "" too.
There was a problem hiding this comment.
Ah, I think I'm referring to when page is "". But if it is None it won't work indeed. So maybe we should simply differentiate the two cases with if page is not None:.
There was a problem hiding this comment.
Yeah my bad, it definitely should be if page is not None. It was to satisfy type checking.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also for event type annotations - if, hypothetically, MkDocs started to support them.