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.

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

Improve Type hints in documentation #589

Open
pathunstrom opened this issue Mar 7, 2021 · 5 comments
Open

Improve Type hints in documentation #589

pathunstrom opened this issue Mar 7, 2021 · 5 comments
Assignees
@lunacodes
Labels
docs We need to add this to the docs. Hacktoberfest Good issues for Hacktoberfest (synced with new contributor) new contributor Apply to issues we think can be tackled by people new to PPB

Comments

@pathunstrom
Copy link
Collaborator

There is apparently a setting to move the type hints from the signature line to the autodocs params generated by Sphinx.

Research what the setting is and implement it.
@pathunstrom pathunstrom added new contributor Apply to issues we think can be tackled by people new to PPB docs We need to add this to the docs. labels Mar 7, 2021
@lfunderburk
Copy link
Contributor

Hi I am not sure where I can find the documentation :/

@AstraLuma
Copy link
Member

The documentation source is in the docs folder.

This issue isn't so much about the contents of the docs as it is about sphinx and how docs are produced.

@AstraLuma
Copy link
Member

AstraLuma commented Mar 7, 2021 •
edited

Example of ugly type hints https://ppb-vector.readthedocs.io/en/stable/#ppb_vector.Vector.__add__

__add__(other: Union[Vector, Tuple[SupportsFloat, SupportsFloat], Sequence[SupportsFloat], Mapping[str, SupportsFloat]]) → ppb_vector.Vector

@AstraLuma
Copy link
Member

(Ideally, this would be __add__(other: Vectorish) → ppb_vector.Vector but I haven't found this feature yet.)

@AstraLuma
Copy link
Member

https://docs.python.org/3.10/whatsnew/3.10.html#pep-613-typealias-annotation

@AstraLuma AstraLuma added the Hacktoberfest Good issues for Hacktoberfest (synced with new contributor) label Oct 1, 2021
@lunacodes lunacodes self-assigned this Nov 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lunacodes lunacodes

Labels
docs We need to add this to the docs. Hacktoberfest Good issues for Hacktoberfest (synced with new contributor) new contributor Apply to issues we think can be tackled by people new to PPB
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@AstraLuma @pathunstrom @lunacodes @lfunderburk