Skip to content

docs: only use type annotations for documentation #1709

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Dec 1, 2021
Merged

docs: only use type annotations for documentation #1709

merged 5 commits into from
Dec 1, 2021

Conversation

nejch
Copy link
Member

@nejch nejch commented Nov 24, 2021 •
edited
Loading

We probably still have a lot of incorrect types in the docstrings and this should just take care of it in the future.

Before After
image image

Clashes with the internal extension though so needs more work

@nejch nejch marked this pull request as draft November 24, 2021 20:07
@JohnVillalovos
Copy link
Member

Looks cool! Thanks for this. I'll review once you mark it ready for review.

@nejch nejch force-pushed the docs/sphinx-annotations branch from e262867 to af0cb4d Compare November 28, 2021 17:41
@nejch
Copy link
Member Author

nejch commented Nov 28, 2021

Turns out I was just using an outdated external module but it's now part of autodoc so it was just a matter of adding a flag. This looks a bit more like the original now, but pulls typehints from code. Should be ready now.

@nejch nejch marked this pull request as ready for review November 28, 2021 17:43
@nejch nejch requested a review from JohnVillalovos November 28, 2021 17:43
JohnVillalovos
JohnVillalovos approved these changes Nov 29, 2021
View reviewed changes
Copy link
Member

@JohnVillalovos JohnVillalovos left a comment

Choose a reason for hiding this comment

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

I'm okay to merge it as is.

Thanks for doing this.

@nejch nejch requested a review from JohnVillalovos December 1, 2021 00:06
JohnVillalovos
JohnVillalovos approved these changes Dec 1, 2021
View reviewed changes
Copy link
Member

@JohnVillalovos JohnVillalovos left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Please merge whenever you want to.

@nejch nejch merged commit 2708f91 into main Dec 1, 2021
@nejch nejch deleted the docs/sphinx-annotations branch December 1, 2021 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JohnVillalovos JohnVillalovos JohnVillalovos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nejch @JohnVillalovos