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

function signature styling in docs #2666

Open
d-v-b opened this issue Jan 7, 2025 · 0 comments
Open

function signature styling in docs #2666

d-v-b opened this issue Jan 7, 2025 · 0 comments
Labels
documentation Improvements to the documentation

Comments

@d-v-b
Copy link
Contributor

d-v-b commented Jan 7, 2025

Does anyone else find the way the return type is displayed here a bit confusing? Why are we representing the function signature with func_name(-> <return type>)? If we want to represent the function signature at all, surely it should be func_name(<parameters>) -> <return type>

Image
@jhamman jhamman added the documentation Improvements to the documentation label Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements to the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jhamman @d-v-b